Back to top

SmartZone 100 Public API Reference Guide

Overview

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

All API URIs in this guide could use the below all common prefix, where {host} is the IP address of the management interface of the controller.

Prefix Pattern Note
https://{host}:8443/wsg/api/public Recommend
https://{host}:7443/api/public Deprecated Will be removed in the future version

OpenAPI documents

OpenAPI documents is based on OAS 2.0, Please try it for free.
Installed Smart Zone Software Release and link to https://{host}:8443/wsg/apiDoc/openapi for the detail.
You can get the usage at https://swagger.io/, use the Swagger tools to meet your needs.

Version Matrix

SmartZone software has API support according to the following matrix.

SZ Version API Version
6.1.1 v9_0 v9_1 v10_0 v11_0 v11_1

Common Request Header

The following parameters are required in the HTTP headers of all API requests.

Parameter Value
Content-Type “application/json;charset=UTF-8”

Common Request URI Parameters

The following parameters are required in the Request URI Parameters of all API requests (except for the logon API).

Parameter Value
serviceTicket {serviceTicket}

serviceTicket is returned as the following parameter in the response payload of the Service Ticket Logon API.

Request Header for Session

Deprecated : Will be removed in the future version, please refer to the [Common Request URI Parameters] section

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

Parameter Value
Cookie “JSESSIONID={JSESSIONID}”

JSESSIONID is returned as the following parameter in the response header of the Session ID Logon API.

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

HTTP Responses

HTTP response status codes indicate whether a specific HTTP request has been successfully completed.
The available status codes are defined by RFC7231 and registered status codes are listed in the IANA Status Code Registry.

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
152 Operation is not allowed because this is a standby cluster
201 No active session
202 Login denied
203 Password expired
204 Account is disabled
205 Account not found
206 Account is locked
207 User is not assigned to an admin user group
211 Insufficient administrative privileges
212 Resource access denied
301 Resource cannot be found
302 Business rule violation
303 Illegal arguments
304 Bulk operation fail

Usage for Query Criteria

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

Not Support URIs

Due to the feature has been changed the design. There below URIs are no longer support in all API version as below.

  • Ruckus Wireless AP Zone

    Remove
    DELETE rkszones/{zoneId}/backgroundScanning24
    DELETE rkszones/{zoneId}/backgroundScanning50

  • AP Group

    Remove
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/wlanGroup24
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/wlanGroup50
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/wifi24
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/wifi50
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/wifi24/txPower
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/wifi50/txPower
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/wifi24/channelWidth
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/wifi50/channelWidth
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/wifi24/channel
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/wifi50/indoorChannel
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/wifi50/outdoorChannel
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/wifi24/channelRange
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/wifi50/indoorChannelRange
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/wifi50/outdoorChannelRange
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/autoChannelSelection24
    DELETE rkszones/{zoneId}/apgroups/{apgroupId}/autoChannelSelection50

  • Access Point Configuration

    Remove
    DELETE aps/{apMac}/autoChannelSelection24
    DELETE aps/{apMac}/autoChannelSelection50
    DELETE aps/{apMac}/protectionMode24
    DELETE aps/{apMac}/wifi24
    DELETE aps/{apMac}/wifi50
    DELETE aps/{apMac}/wifi24/txPower
    DELETE aps/{apMac}/wifi50/txPower
    DELETE aps/{apMac}/wifi24/channelWidth
    DELETE aps/{apMac}/wifi50/channelWidth
    DELETE aps/{apMac}/wifi24/channel
    DELETE aps/{apMac}/wifi50/channel
    DELETE aps/{apMac}/wifi24/channelRange
    DELETE aps/{apMac}/wifi50/channelRange
    DELETE aps/{apMac}/wlanGroup24
    DELETE aps/{apMac}/wlanGroup50

Not Support Properties

Due to the feature has been changed the design. There below properties are no longer support in all API version as below.

  • WLAN

    Create
    bssMinRate6g
    mgmtTxRate6g
    Retrieve
    bssMinRate6g
    mgmtTxRate6g
    Modify
    bssMinRate6g
    mgmtTxRate6g
    Remove
    bssMinRate6g
    mgmtTxRate6g

What’s New

  • API

  • Properties

    • Access Point Operational
      • Retrieve Operational Information
        • wifi6gChannel
    • Cluster Management
      • Modify Auto Export Backup
        • ftpNamePrefix
      • Modify Auto Export Backup
        • ftpNamePrefix
      • Get Auto Export Backup
        • ftpNamePrefix
    • LBS profile
      • Create LBS profile
        • tlsVersion
      • Create LBS profile
        • tlsVersion
      • Create LBS profile
        • tlsVersion
      • Update LBS profile
        • tlsVersion
      • Update LBS profile
        • tlsVersion
    • WLAN
      • Retrieve
        • oweTransWlanId
    • Ethernet Port Profile
      • Modify - Ethernet Port Porfile
        • clientIsolationEnabled, clientIsolationUnicastEnabled, clientIsolationMulticastEnabled, clientIsolationAutoVrrpEnabled, clientIsolationWhitelist
      • Modify - Ethernet Port Porfile
        • clientIsolationEnabled, clientIsolationUnicastEnabled, clientIsolationMulticastEnabled, clientIsolationAutoVrrpEnabled, clientIsolationWhitelist
      • Modify Entire - Ethernet Port Porfile
        • clientIsolationEnabled, clientIsolationUnicastEnabled, clientIsolationMulticastEnabled, clientIsolationAutoVrrpEnabled, clientIsolationWhitelist
      • Modify Entire - Ethernet Port Porfile
        • clientIsolationEnabled, clientIsolationUnicastEnabled, clientIsolationMulticastEnabled, clientIsolationAutoVrrpEnabled, clientIsolationWhitelist
      • Retrieve - Ethernet Port Porfile
        • clientIsolationEnabled, clientIsolationUnicastEnabled, clientIsolationMulticastEnabled, clientIsolationAutoVrrpEnabled, clientIsolationWhitelist
      • Create - Ethernet Port Porfile
        • clientIsolationEnabled, clientIsolationUnicastEnabled, clientIsolationMulticastEnabled, clientIsolationAutoVrrpEnabled, clientIsolationWhitelist
      • Create - Ethernet Port Porfile
        • clientIsolationEnabled, clientIsolationUnicastEnabled, clientIsolationMulticastEnabled, clientIsolationAutoVrrpEnabled, clientIsolationWhitelist

What’s Deprecated

  • API

API Information

Retrieve API information

GET/apiInfo

Use this API command to retrieve API information.

Response  200
HideShow
Body
{
  "apiSupportVersions": [
    "v6_0",
    "v6_1",
    "v7_0",
    "v8_0",
    "v8_1",
    "v8_2",
    "v9_0"
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "apiSupportVersions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Logon

Service Ticket

  • Logon

POST/v11_1/serviceTicket

Use this API command to log on to the controller and acquire a valid service ticket. The service ticket will expire in 24 hours. It is recommended to use the same valid service ticket for multiple API calls during its validity period.

Request
HideShow
Body
{
  "username": "admin",
  "password": "admin!234"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "username": {
      "description": "Logon user name",
      "type": "string"
    },
    "password": {
      "description": "Logon password",
      "type": "string"
    }
  },
  "required": [
    "username",
    "password"
  ]
}
Response  200
HideShow
Body
{
  "controllerVersion": "5.0.0.0.451",
  "serviceTicket": "ST-8-fZbanC02T6zpzvMFZocF-neil50-451"
}
Schema
{
  "type": "object",
  "properties": {
    "controllerVersion": {
      "type": "string"
    },
    "serviceTicket": {
      "description": "Logon authentication successful, the server generates a service ticket",
      "type": "string"
    }
  }
}

  • Logoff

DELETE/v11_1/serviceTicket

Use this API command to log off of the controller.

URI Parameters
HideShow
serviceTicket
string (required) 
Response  200

Session ID

  • Retrieve

GET/v11_1/session

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

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

  • Logon

POST/v11_1/session

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

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

  • Logoff

DELETE/v11_1/session

Use this API command to log off of the controller.

Response  200

Session Management

Retrieve

GET/v11_1/sessionManagement

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

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "authType": "PUBLIC_API",
      "lastAccessTime": 1536290141430,
      "lastAccessURI": "/v8_0/sessionManagement",
      "sessionId": "5C2450F464951DD70FDA73D68824A547",
      "sourceIp": "127.0.0.1",
      "userName": "admin",
      "userUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    },
    {
      "authType": "PUBLIC_API",
      "lastAccessTime": 1536290095781,
      "lastAccessURI": null,
      "sessionId": "6991866A7F5689C859D09B33C31A262A",
      "sourceIp": "127.0.0.1",
      "userName": "admin",
      "userUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "lastAccessTime": {
            "type": "string",
            "description": "The last access time"
          },
          "lastAccessURI": {
            "type": "string",
            "description": "The last access URI"
          },
          "userUUID": {
            "type": "string",
            "description": "The user UUID"
          },
          "userName": {
            "type": "string",
            "description": "Logon user name"
          },
          "sessionId": {
            "type": "string",
            "description": "The user session ID"
          },
          "sourceIp": {
            "type": "string",
            "description": "The source IP address"
          },
          "authType": {
            "type": "string",
            "description": "The authentication type of logon"
          }
        }
      }
    }
  }
}

Ruckus Wireless AP Zone

Retrieve List

GET/v11_1/rkszones

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

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

domainId
string (optional) 

The domain ID. Default: current logon domain ID

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

Retrieve Mesh Configuration

GET/v11_1/rkszones/{id}/mesh

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

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ssid": {
      "description": "SSID of the mesh network",
      "type": "string"
    },
    "passphrase": {
      "description": "Passphrase for the mesh network. Would be mandatory when the mesh is enabled.",
      "type": "string"
    },
    "meshRadioIdx": {
      "description": "Mesh radio index",
      "type": "string",
      "enum": [
        "Radio24G",
        "Radio5G"
      ],
      "default": "Radio5G"
    },
    "zeroTouchStatus": {
      "type": "boolean"
    }
  }
}

Retrieve AP Model

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

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

Response  200
HideShow
Body
{
  "ledStatusEnabled": true,
  "lacp": {
    "keepApSetting": false,
    "enabled": true,
    "bondPortProfileId": "ed395d1c-45a7-4d85-994f-244c38c83f2c"
  },
  "lldp": {
    "enabled": true,
    "advertiseIntervalInSec": 30,
    "holdTimeInSec": 120,
    "managementIPTLVEnabled": false
  },
  "cellularSettings": {
    "mobileAPName": "internet",
    "mobileAPName2": "internet",
    "simCardUsage": 0,
    "select3g4g": 0,
    "select3g4g2": 0,
    "dataRoaming": 1,
    "dataRoaming2": 1,
    "wanConnection": 0,
    "wanRecoveryTimer": 60
  },
  "ledMode": null,
  "internalHeaterEnabled": null,
  "poeOutPortEnabled": null,
  "usbPowerEnable": true,
  "poeModeSetting": "Auto",
  "poeTxChain": 2,
  "radioBand": null,
  "externalAntenna24": null,
  "externalAntenna50": null,
  "lanPorts": [
    {
      "portName": "LAN1",
      "enabled": false,
      "ethPortProfile": null
    },
    {
      "portName": "LAN2",
      "enabled": true,
      "ethPortProfile": {
        "id": "0",
        "name": "Default Trunk Port"
      }
    },
    {
      "portName": "LAN3",
      "enabled": true,
      "ethPortProfile": {
        "id": "1",
        "name": "Default Access Port"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ledStatusEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "lldp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean",
          "default": true
        },
        "advertiseIntervalInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 300
        },
        "holdTimeInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 60,
          "maximum": 1200
        },
        "managementIPTLVEnabled": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lacp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "keepApSetting": {
          "type": "boolean"
        },
        "enabled": {
          "type": "boolean"
        },
        "bondPortProfileId": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "cellularSettings": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mobileAPName": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
        },
        "mobileAPName2": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
        },
        "simCardUsage": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 2
        },
        "select3g4g": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2
        },
        "select3g4g2": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2
        },
        "dataRoaming": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 1
        },
        "dataRoaming2": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 1
        },
        "wanConnection": {
          "type": "integer",
          "minimum": 0,
          "maximum": 3
        },
        "wanRecoveryTimer": {
          "type": "integer",
          "minimum": 10,
          "maximum": 300
        }
      },
      "required": [
        "select3g4g",
        "select3g4g2",
        "wanConnection",
        "wanRecoveryTimer"
      ]
    },
    "ledMode": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        null,
        "CableModem",
        "AccessPoint",
        "CableModem_AccessPoint",
        "CableModem_AccessPoint_DEFAULT",
        "ActiveSurgeProtector",
        "ActiveSurgeProtector_ModemOnline_DEFAULT",
        "Off"
      ]
    },
    "internalHeaterEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeOutPortEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "usbPowerEnable": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeModeSetting": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "Auto",
        "_802_3af",
        "_802_3at",
        "_802_3atPlus",
        "_802_3bt_Class_5",
        "_802_3bt_Class_6",
        "_802_3bt_Class_7",
        "_802_3bt_Class_8",
        null
      ]
    },
    "poeTxChain": {
      "description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
      "default": 2,
      "type": [
        "integer",
        "null"
      ]
    },
    "radioBand": {
      "description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
      "type": [
        "string",
        "null"
      ],
      "enum": [
        null,
        "2.4GHz",
        "5GHz"
      ]
    },
    "externalAntenna24": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "dbi": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 90
        },
        "chainMask": {
          "type": [
            "string",
            "null"
          ],
          "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": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            null,
            "Two",
            "Three"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lanPorts": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "portName": {
            "type": "string",
            "enum": [
              "LAN1",
              "LAN2",
              "LAN3",
              "LAN4",
              "LAN5"
            ]
          },
          "enabled": {
            "type": "boolean"
          },
          "ethPortProfile": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "portName",
          "enabled"
        ]
      }
    }
  }
}

Retrieve AP Model Common Attribute

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

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

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

Retrieve AP Firmware List

GET/v11_1/rkszones/{zoneId}/apFirmware

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

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

Get Available GRE Tunnel Profiles.

GET/v11_1/rkszones/{zoneId}/availableTunnelProfiles

Get available GRE tunnel profiles of this Zone.

Response  200
HideShow
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": "Tunnel Profile ID",
            "type": "string"
          },
          "name": {
            "description": "Tunnel Profile Name",
            "type": "string"
          },
          "tunnelType": {
            "description": "Tunnel Profile Type (\"RuckusGRE\", \"SoftGRE\",or \"Ipsec\")",
            "type": "string",
            "enum": [
              "RuckusGRE",
              "SoftGRE",
              "Ipsec"
            ]
          },
          "ipMode": {
            "description": "Tunnel Profile's IP Mode",
            "type": "string",
            "enum": [
              "IPV4",
              "IPV6",
              "IPV4_IPV6"
            ]
          },
          "aaaAffinityEnabled": {
            "description": "Enable AAA affinity (Soft GRE only)",
            "type": "boolean"
          }
        }
      }
    }
  }
}

Get available IPSec Tunnel Profiles.

GET/v11_1/rkszones/{zoneId}/availableIpsecProfiles

Get available IPSec tunnel profiles of this Zone.

Response  200
HideShow
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": "Tunnel Profile ID",
            "type": "string"
          },
          "name": {
            "description": "Tunnel Profile Name",
            "type": "string"
          },
          "tunnelType": {
            "description": "Tunnel Profile Type (\"RuckusGRE\", \"SoftGRE\",or \"Ipsec\")",
            "type": "string",
            "enum": [
              "RuckusGRE",
              "SoftGRE",
              "Ipsec"
            ]
          },
          "ipMode": {
            "description": "Tunnel Profile's IP Mode",
            "type": "string",
            "enum": [
              "IPV4",
              "IPV6",
              "IPV4_IPV6"
            ]
          },
          "aaaAffinityEnabled": {
            "description": "Enable AAA affinity (Soft GRE only)",
            "type": "boolean"
          }
        }
      }
    }
  }
}

Retrieve

GET/v11_1/rkszones/{id}

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

Response  200
HideShow
Body
{
  "id": "ad5ffab1-b3ed-4b36-b054-bc723a977dbb",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "public-api-zone-ipv6",
  "description": null,
  "countryCode": "US",
  "version": "3.1.0.0.55",
  "timezone": {
    "systemTimezone": "UTC",
    "customizedTimezone": null
  },
  "ipMode": "IPV6",
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "mesh": null,
  "dfsChannelEnabled": false,
  "cbandChannelEnabled": false,
  "cbandChannelLicenseEnabled": false,
  "channel144Enabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ],
    "availableChannelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ],
    "availableIndoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "availableOutdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "syslog": null,
  "smartMonitor": null,
  "clientAdmissionControl24": null,
  "clientAdmissionControl50": null,
  "channelModeEnabled": false,
  "tunnelType": "SoftGREIpsec",
  "tunnelProfile": {
    "id": "tunnelProfileId",
    "name": "tunnelProfileName"
  },
  "backgroundScanning24": null,
  "backgroundScanning50": null,
  "loadBalancing": {
    "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
    "clientLoadBalancing24": {
      "adjacentRadioThreshold": 12
    },
    "clientLoadBalancing50": {
      "adjacentRadioThreshold": 12
    },
    "bandBalancing": {
      "wifi24Percentage": 10
    },
    "steeringMode": "BASIC"
  },
  "rogue": null,
  "locationBasedService": null,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": null,
  "locationAdditionalInfo": null,
  "latitude": null,
  "longitude": null,
  "vlanOverlappingEnabled": false,
  "nodeAffinityProfile": null,
  "venueProfile": null,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "autoPurgeExpiredDpsk": "OneDay",
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "dhcpSiteConfig": {
    "zoneName": "zoneK",
    "siteEnabled": true,
    "portSelectionEnabled": false,
    "dwpdEnabled": false,
    "manualSelect": true,
    "siteMode": "EnableOnMultipleAPs",
    "siteAps": [
      {
        "apMac": "38:FF:36:00:0E:10",
        "apServerEnabled": true,
        "apServerPrimary": true
      },
      {
        "apMac": "58:FF:36:00:0E:20",
        "apServerEnabled": true,
        "apServerPrimary": false
      }
    ],
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "rogueApReportThreshold": 40,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingDetection": true,
  "rogueApJammingThreshold": 40,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "healthCheckSitesEnabled": true,
  "healthCheckSites": [
    "www.google.com",
    "www.live.com:443",
    "www.github.com:443",
    "source.codeaurora.org:443",
    "www.wikipedia.com"
  ],
  "ruckusGreTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "softGreTunnelProflies": [
    {
      "id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
      "name": "softGre1",
      "aaaAffinityEnabled": true
    },
    {
      "id": "7803e411-df53-11e7-98e1-08002748d78e",
      "name": "softGre2",
      "aaaAffinityEnabled": true
    }
  ],
  "ipsecProfiles": [
    {
      "id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
      "name": "ipsec1"
    }
  ],
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "apHccdEnabled": true,
  "apHccdPersist": true,
  "rksGreForwardBroadcast": false
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the zone",
            "type" : "string"
        },
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "description" : "AP firmware version of the zone",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "timezone" : {
            "description" : "Time zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the 'Overview > Time Zone' list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "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)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "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)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "ipMode" : {
            "description" : "IP mode of the zone",
            "type" : "string",
            "enum" : [ "IPV4", "IPV6", "IPV4_IPV6" ]
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network. Would be mandatory when the mesh is enabled.",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "syslogConfigType" : {
                    "description" : "Syslog configuration type.",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "syslogServerProfileId" : {
                    "description" : "Syslog server profile ID.",
                    "type" : "string"
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
            "default" : "RuckusGRE"
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "loadBalancing" : {
            "description" : "Load Balancing configuration of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "loadBalancingMethod" : {
                    "type" : "string",
                    "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
                    "default" : "BASED_ON_CLIENT_COUNT"
                },
                "bandBalancing" : {
                    "description" : "Band Balancing configuration of the zone.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "wifi24Percentage" : {
                            "description" : "Percentage of client load on 2.4GHz radio band",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100,
                            "default" : 25
                        }
                    }
                },
                "steeringMode" : {
                    "description" : "Steering Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
                    "default" : "BASIC"
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "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 ],
                    "default" : 1800
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
                    "default" : 7200
                }
            }
        },
        "location" : {
            "description" : "Location of the Zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "venue profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "AP latency interval",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean",
                    "default" : true
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "restrictedApAccessEnabled" : {
            "description" : "Enable Restricted AP Access of the zone.",
            "type" : "boolean"
        },
        "restrictedApAccessProfileId" : {
            "description" : "Restricted AP Access Profile Id of the zone.",
            "type" : "string"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Config in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "portSelectionEnabled" : {
                    "description" : "DHCP Port Selection Enabled",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpConfigType" : {
                    "description" : "The config type of SNMP",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SNMP_AGENT_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "apSnmpAgentProfileId" : {
                    "type" : "string"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "Custom recovery ssid passphrase. If passphrase has been customized, this property cannot be empty in the future. ",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone",
            "type" : "boolean"
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "description" : "Enable jamming detection.",
            "type" : "boolean"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "description" : "Directed multicast from wired client.",
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "description" : "Directed multicast from wireless client.",
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "description" : "Directed multicast from network.",
            "type" : "boolean"
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean",
            "default" : false
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "ipsecTunnelMode" : {
            "type" : "string",
            "enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
        },
        "rksGreForwardBroadcast" : {
            "description" : "Ruckus GRE tunnel broadcast packet forwarding",
            "type" : "boolean",
            "default" : false
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ]
        },
        "lteBandLockChannels" : {
            "description" : "LTE band lock channels options",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "paloAltoFirewallProfileId" : {
            "type" : "string"
        },
        "apHccdEnabled" : {
            "description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
            "type" : "boolean",
            "default" : false
        },
        "apHccdPersist" : {
            "description" : "Allow Historical Connection Failures to be persisted.",
            "type" : "boolean",
            "default" : true
        },
        "aaaAffinityEnabled" : {
            "type" : "boolean"
        },
        "myRuckusConfig" : {
            "description" : "My.Ruckus configuration",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "aclForTunnelWlanAndVlanEnable" : {
                    "description" : "My.Ruckus support for tunnel-wlan/vlan",
                    "type" : "boolean"
                }
            },
            "required" : [ "aclForTunnelWlanAndVlanEnable" ]
        },
        "apHttp2CertChkEnable" : {
            "type" : "boolean"
        },
        "bssColoringEnable" : {
            "description" : "BSS coloring mechanism enabled.",
            "type" : "boolean"
        },
        "radioConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "radio24g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "availableChannelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "availableChannelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "availableChannelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gUpper" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "availableChannelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "availableChannelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gLower" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "availableChannelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "availableChannelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio6g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "lowPowerIndoorModeEnabled" : {
                            "type" : "boolean"
                        },
                        "availableChannelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        },
                        "bssMinRate" : {
                            "description" : "6G BSS minimum rate (mbps)",
                            "type" : "string",
                            "enum" : [ "HE-MCS0", "HE-MCS1", "HE-MCS2", "HE-MCS3" ]
                        },
                        "mgmtTxRate" : {
                            "description" : "6G management TX rate (mbps)",
                            "type" : "string",
                            "enum" : [ "6 mbps", "9 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
                        },
                        "multicastUplinkRateLimit" : {
                            "description" : "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        },
                        "multicastDownlinkRateLimit" : {
                            "description" : "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        }
                    }
                },
                "dual5gEnabled" : {
                    "type" : "boolean"
                }
            }
        }
    }
}

Create Zone of IPv6

POST/v11_1/rkszones/ipv6

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

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "createZoneName",
  "description": "description Zone",
  "countryCode": "US",
  "timezone": {
    "customizedTimezone": {
      "abbreviation": "TPE",
      "gmtOffset": 0,
      "gmtOffsetMinute": 0
    }
  },
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "syslog": {
    "flowLevel": "GENERAL_LOGS",
    "address": "1.1.1.1",
    "port": 514,
    "protocol": "IPPROTO_TCP",
    "secondaryAddress": "2.2.2.2",
    "secondaryPort": 514,
    "secondaryProtocol": "IPPROTO_TCP",
    "facility": "Local0",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "channelModeEnabled": false,
  "tunnelType": "RuckusGRE",
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "loadBalancing": {
    "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
    "clientLoadBalancing24": {
      "adjacentRadioThreshold": 12
    },
    "clientLoadBalancing50": {
      "adjacentRadioThreshold": 12
    },
    "bandBalancing": {
      "wifi24Percentage": 10
    },
    "steeringMode": "BASIC"
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "apLatencyInterval": {
    "pingEnabled": true
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": false,
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "dhcpSiteConfig": {
    "siteEnabled": true,
    "siteMode": "EnableOnEachAPs",
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "rogueApReportThreshold": 40,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingDetection": true,
  "rogueApJammingThreshold": 40,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "healthCheckSitesEnabled": true,
  "healthCheckSites": [
    "www.google.com",
    "www.live.com:443",
    "www.github.com:443",
    "source.codeaurora.org:443",
    "www.wikipedia.com"
  ],
  "ruckusGreTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "softGreTunnelProflies": [
    {
      "id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
      "name": "softGre1",
      "aaaAffinityEnabled": false
    },
    {
      "id": "7803e411-df53-11e7-98e1-08002748d78e",
      "name": "softGre2",
      "aaaAffinityEnabled": true
    },
    {
      "id": "664de4f1-df53-11e7-98e1-08002748d78e",
      "name": "softGre3",
      "aaaAffinityEnabled": false
    }
  ],
  "ipsecProfiles": [
    {
      "id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
      "name": "ipsec1"
    },
    {
      "id": "832aa331-df65-11e7-98e1-08002748d78e",
      "name": "ipsec2"
    }
  ],
  "sshTunnelEncryption": "AES128",
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [
            "B1",
            "B3",
            "B5"
          ],
          "channel3g": [
            "B5"
          ]
        }
      ]
    },
    {
      "simCardId": 1,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [],
          "channel3g": []
        }
      ]
    }
  ],
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "apHccdEnabled": true,
  "apHccdPersist": true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "description" : "AP firmware version of the zone",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "timezone" : {
            "description" : "Either systemTimezone or customizedTimezone must be specified",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the 'Overview > Time Zone' list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "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)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "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)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network. Would be mandatory when the mesh is enabled.",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "syslogConfigType" : {
                    "description" : "Syslog configuration type.",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "syslogServerProfileId" : {
                    "description" : "Syslog server profile ID.",
                    "type" : "string"
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
            "default" : "RuckusGRE"
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "loadBalancing" : {
            "description" : "Load Balancing configuration of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "loadBalancingMethod" : {
                    "type" : "string",
                    "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
                    "default" : "BASED_ON_CLIENT_COUNT"
                },
                "bandBalancing" : {
                    "description" : "Band Balancing configuration of the zone.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "wifi24Percentage" : {
                            "description" : "Percentage of client load on 2.4GHz radio band",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100,
                            "default" : 25
                        }
                    }
                },
                "steeringMode" : {
                    "description" : "Steering Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
                    "default" : "BASIC"
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer",
            "default" : 60
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer",
            "default" : 5
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer",
            "default" : 30
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "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 ],
                    "default" : 1800
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
                    "default" : 7200
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "AP latency interval",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean",
                    "default" : true
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Configuration in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "portSelectionEnabled" : {
                    "description" : "DHCP Port Selection Enabled",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpConfigType" : {
                    "description" : "The config type of SNMP",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SNMP_AGENT_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "apSnmpAgentProfileId" : {
                    "type" : "string"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "Custom recovery ssid passphrase. If passphrase has been customized, this property cannot be empty in the future. ",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone.",
            "type" : "boolean",
            "default" : false
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "description" : "Enable jamming detection.",
            "type" : "boolean",
            "default" : false
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "description" : "Directed multicast from wired client.",
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "description" : "Directed multicast from wireless client.",
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromNetworkEnabled" : {
            "description" : "Directed multicast from network.",
            "type" : "boolean",
            "default" : true
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean",
            "default" : false
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "ipsecTunnelMode" : {
            "type" : "string",
            "enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
        },
        "rksGreForwardBroadcast" : {
            "description" : "Ruckus GRE tunnel broadcast packet forwarding",
            "type" : "boolean",
            "default" : false
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ],
            "default" : "AES128"
        },
        "lteBandLockChannels" : {
            "description" : "LTE band lock channels options",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "paloAltoFirewallProfileId" : {
            "type" : "string"
        },
        "apHccdEnabled" : {
            "description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
            "type" : "boolean",
            "default" : false
        },
        "apHccdPersist" : {
            "description" : "Allow Historical Connection Failures to be persisted.",
            "type" : "boolean",
            "default" : true
        },
        "myRuckusConfig" : {
            "description" : "My.Ruckus configuration",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "aclForTunnelWlanAndVlanEnable" : {
                    "description" : "My.Ruckus support for tunnel-wlan/vlan",
                    "type" : "boolean"
                }
            },
            "required" : [ "aclForTunnelWlanAndVlanEnable" ]
        },
        "apHttp2CertChkEnable" : {
            "type" : "boolean"
        },
        "bssColoringEnable" : {
            "description" : "Turn on/off BSS coloring mechanism.",
            "type" : "boolean",
            "default" : true
        },
        "radioConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "radio24g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gLower" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gUpper" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio6g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "lowPowerIndoorModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        },
                        "bssMinRate" : {
                            "description" : "6G BSS minimum rate (mbps)",
                            "type" : "string",
                            "enum" : [ "HE-MCS0", "HE-MCS1", "HE-MCS2", "HE-MCS3" ]
                        },
                        "mgmtTxRate" : {
                            "description" : "6G management TX rate (mbps)",
                            "type" : "string",
                            "enum" : [ "6 mbps", "9 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
                        },
                        "multicastUplinkRateLimit" : {
                            "description" : "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        },
                        "multicastDownlinkRateLimit" : {
                            "description" : "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        }
                    }
                },
                "dual5gEnabled" : {
                    "type" : "boolean"
                }
            }
        }
    },
    "required" : [ "name", "login" ]
}
Response  201
HideShow
Body
{
  "id": "zoneUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create Zone of Dual

POST/v11_1/rkszones/dual

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

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "createZoneName",
  "description": "description Zone",
  "countryCode": "US",
  "timezone": {
    "customizedTimezone": {
      "abbreviation": "TPE",
      "gmtOffset": 0,
      "gmtOffsetMinute": 0
    }
  },
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "syslog": {
    "flowLevel": "GENERAL_LOGS",
    "address": "1.1.1.1",
    "port": 514,
    "protocol": "IPPROTO_TCP",
    "secondaryAddress": "2.2.2.2",
    "secondaryPort": 514,
    "secondaryProtocol": "IPPROTO_TCP",
    "facility": "Local0",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "channelModeEnabled": false,
  "tunnelType": "RuckusGRE",
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "loadBalancing": {
    "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
    "clientLoadBalancing24": {
      "adjacentRadioThreshold": 12
    },
    "clientLoadBalancing50": {
      "adjacentRadioThreshold": 12
    },
    "bandBalancing": {
      "wifi24Percentage": 10
    },
    "steeringMode": "BASIC"
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "apLatencyInterval": {
    "pingEnabled": true
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": false,
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "dhcpSiteConfig": {
    "siteEnabled": true,
    "siteMode": "EnableOnEachAPs",
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "rogueApReportThreshold": 40,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingDetection": true,
  "rogueApJammingThreshold": 40,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "healthCheckSitesEnabled": true,
  "healthCheckSites": [
    "www.google.com",
    "www.live.com:443",
    "www.github.com:443",
    "source.codeaurora.org:443",
    "www.wikipedia.com"
  ],
  "ruckusGreTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "softGreTunnelProflies": [
    {
      "id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
      "name": "softGre1",
      "aaaAffinityEnabled": false
    },
    {
      "id": "7803e411-df53-11e7-98e1-08002748d78e",
      "name": "softGre2",
      "aaaAffinityEnabled": true
    },
    {
      "id": "664de4f1-df53-11e7-98e1-08002748d78e",
      "name": "softGre3",
      "aaaAffinityEnabled": false
    }
  ],
  "ipsecProfiles": [
    {
      "id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
      "name": "ipsec1"
    },
    {
      "id": "832aa331-df65-11e7-98e1-08002748d78e",
      "name": "ipsec2"
    }
  ],
  "sshTunnelEncryption": "AES128",
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [
            "B1",
            "B3",
            "B5"
          ],
          "channel3g": [
            "B5"
          ]
        }
      ]
    },
    {
      "simCardId": 1,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [],
          "channel3g": []
        }
      ]
    }
  ],
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "apHccdEnabled": true,
  "apHccdPersist": true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "description" : "AP firmware version of the zone",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "timezone" : {
            "description" : "Either systemTimezone or customizedTimezone must be specified",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the 'Overview > Time Zone' list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "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)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "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)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network. Would be mandatory when the mesh is enabled.",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "syslogConfigType" : {
                    "description" : "Syslog configuration type.",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "syslogServerProfileId" : {
                    "description" : "Syslog server profile ID.",
                    "type" : "string"
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
            "default" : "RuckusGRE"
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "loadBalancing" : {
            "description" : "Load Balancing configuration of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "loadBalancingMethod" : {
                    "type" : "string",
                    "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
                    "default" : "BASED_ON_CLIENT_COUNT"
                },
                "bandBalancing" : {
                    "description" : "Band Balancing configuration of the zone.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "wifi24Percentage" : {
                            "description" : "Percentage of client load on 2.4GHz radio band",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100,
                            "default" : 25
                        }
                    }
                },
                "steeringMode" : {
                    "description" : "Steering Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
                    "default" : "BASIC"
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer",
            "default" : 60
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer",
            "default" : 5
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer",
            "default" : 30
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "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 ],
                    "default" : 1800
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
                    "default" : 7200
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "AP latency interval",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean",
                    "default" : true
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Configuration in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "portSelectionEnabled" : {
                    "description" : "DHCP Port Selection Enabled",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpConfigType" : {
                    "description" : "The config type of SNMP",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SNMP_AGENT_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "apSnmpAgentProfileId" : {
                    "type" : "string"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "Custom recovery ssid passphrase. If passphrase has been customized, this property cannot be empty in the future. ",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone.",
            "type" : "boolean",
            "default" : false
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "description" : "Enable jamming detection.",
            "type" : "boolean",
            "default" : false
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "description" : "Directed multicast from wired client.",
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "description" : "Directed multicast from wireless client.",
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromNetworkEnabled" : {
            "description" : "Directed multicast from network.",
            "type" : "boolean",
            "default" : true
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean",
            "default" : false
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "ipsecTunnelMode" : {
            "type" : "string",
            "enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
        },
        "rksGreForwardBroadcast" : {
            "description" : "Ruckus GRE tunnel broadcast packet forwarding",
            "type" : "boolean",
            "default" : false
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ],
            "default" : "AES128"
        },
        "lteBandLockChannels" : {
            "description" : "LTE band lock channels options",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "paloAltoFirewallProfileId" : {
            "type" : "string"
        },
        "apHccdEnabled" : {
            "description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
            "type" : "boolean",
            "default" : false
        },
        "apHccdPersist" : {
            "description" : "Allow Historical Connection Failures to be persisted.",
            "type" : "boolean",
            "default" : true
        },
        "myRuckusConfig" : {
            "description" : "My.Ruckus configuration",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "aclForTunnelWlanAndVlanEnable" : {
                    "description" : "My.Ruckus support for tunnel-wlan/vlan",
                    "type" : "boolean"
                }
            },
            "required" : [ "aclForTunnelWlanAndVlanEnable" ]
        },
        "apHttp2CertChkEnable" : {
            "type" : "boolean"
        },
        "bssColoringEnable" : {
            "description" : "Turn on/off BSS coloring mechanism.",
            "type" : "boolean",
            "default" : true
        },
        "radioConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "radio24g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gLower" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gUpper" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio6g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "lowPowerIndoorModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        },
                        "bssMinRate" : {
                            "description" : "6G BSS minimum rate (mbps)",
                            "type" : "string",
                            "enum" : [ "HE-MCS0", "HE-MCS1", "HE-MCS2", "HE-MCS3" ]
                        },
                        "mgmtTxRate" : {
                            "description" : "6G management TX rate (mbps)",
                            "type" : "string",
                            "enum" : [ "6 mbps", "9 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
                        },
                        "multicastUplinkRateLimit" : {
                            "description" : "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        },
                        "multicastDownlinkRateLimit" : {
                            "description" : "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        }
                    }
                },
                "dual5gEnabled" : {
                    "type" : "boolean"
                }
            }
        }
    },
    "required" : [ "name", "login" ]
}
Response  201
HideShow
Body
{
  "id": "zoneUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create Zone

POST/v11_1/rkszones

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

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "createZoneName",
  "description": "description Zone",
  "countryCode": "US",
  "timezone": {
    "customizedTimezone": {
      "abbreviation": "TPE",
      "gmtOffset": 0,
      "gmtOffsetMinute": 0
    }
  },
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "syslog": {
    "flowLevel": "GENERAL_LOGS",
    "address": "1.1.1.1",
    "port": 514,
    "protocol": "IPPROTO_TCP",
    "secondaryAddress": "2.2.2.2",
    "secondaryPort": 514,
    "secondaryProtocol": "IPPROTO_TCP",
    "facility": "Local0",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "channelModeEnabled": false,
  "tunnelType": "RuckusGRE",
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "loadBalancing": {
    "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
    "clientLoadBalancing24": {
      "adjacentRadioThreshold": 12
    },
    "clientLoadBalancing50": {
      "adjacentRadioThreshold": 12
    },
    "bandBalancing": {
      "wifi24Percentage": 10
    },
    "steeringMode": "BASIC"
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "apLatencyInterval": {
    "pingEnabled": true
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": false,
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "dhcpSiteConfig": {
    "siteEnabled": true,
    "siteMode": "EnableOnEachAPs",
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "rogueApReportThreshold": 40,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingDetection": true,
  "rogueApJammingThreshold": 40,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "healthCheckSitesEnabled": true,
  "healthCheckSites": [
    "www.google.com",
    "www.live.com:443",
    "www.github.com:443",
    "source.codeaurora.org:443",
    "www.wikipedia.com"
  ],
  "ruckusGreTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "softGreTunnelProflies": [
    {
      "id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
      "name": "softGre1",
      "aaaAffinityEnabled": false
    },
    {
      "id": "7803e411-df53-11e7-98e1-08002748d78e",
      "name": "softGre2",
      "aaaAffinityEnabled": true
    },
    {
      "id": "664de4f1-df53-11e7-98e1-08002748d78e",
      "name": "softGre3",
      "aaaAffinityEnabled": false
    }
  ],
  "ipsecProfiles": [
    {
      "id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
      "name": "ipsec1"
    },
    {
      "id": "832aa331-df65-11e7-98e1-08002748d78e",
      "name": "ipsec2"
    }
  ],
  "sshTunnelEncryption": "AES128",
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [
            "B1",
            "B3",
            "B5"
          ],
          "channel3g": [
            "B5"
          ]
        }
      ]
    },
    {
      "simCardId": 1,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [],
          "channel3g": []
        }
      ]
    }
  ],
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "apHccdEnabled": true,
  "apHccdPersist": true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "description" : "AP firmware version of the zone",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "timezone" : {
            "description" : "Either systemTimezone or customizedTimezone must be specified",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the 'Overview > Time Zone' list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "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)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "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)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network. Would be mandatory when the mesh is enabled.",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "syslogConfigType" : {
                    "description" : "Syslog configuration type.",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "syslogServerProfileId" : {
                    "description" : "Syslog server profile ID.",
                    "type" : "string"
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
            "default" : "RuckusGRE"
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "loadBalancing" : {
            "description" : "Load Balancing configuration of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "loadBalancingMethod" : {
                    "type" : "string",
                    "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
                    "default" : "BASED_ON_CLIENT_COUNT"
                },
                "bandBalancing" : {
                    "description" : "Band Balancing configuration of the zone.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "wifi24Percentage" : {
                            "description" : "Percentage of client load on 2.4GHz radio band",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100,
                            "default" : 25
                        }
                    }
                },
                "steeringMode" : {
                    "description" : "Steering Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
                    "default" : "BASIC"
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer",
            "default" : 60
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer",
            "default" : 5
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer",
            "default" : 30
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "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 ],
                    "default" : 1800
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
                    "default" : 7200
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "AP latency interval",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean",
                    "default" : true
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Configuration in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "portSelectionEnabled" : {
                    "description" : "DHCP Port Selection Enabled",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpConfigType" : {
                    "description" : "The config type of SNMP",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SNMP_AGENT_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "apSnmpAgentProfileId" : {
                    "type" : "string"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "Custom recovery ssid passphrase. If passphrase has been customized, this property cannot be empty in the future. ",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone.",
            "type" : "boolean",
            "default" : false
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "description" : "Enable jamming detection.",
            "type" : "boolean",
            "default" : false
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "description" : "Directed multicast from wired client.",
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "description" : "Directed multicast from wireless client.",
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromNetworkEnabled" : {
            "description" : "Directed multicast from network.",
            "type" : "boolean",
            "default" : true
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean",
            "default" : false
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "ipsecTunnelMode" : {
            "type" : "string",
            "enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
        },
        "rksGreForwardBroadcast" : {
            "description" : "Ruckus GRE tunnel broadcast packet forwarding",
            "type" : "boolean",
            "default" : false
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ],
            "default" : "AES128"
        },
        "lteBandLockChannels" : {
            "description" : "LTE band lock channels options",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "paloAltoFirewallProfileId" : {
            "type" : "string"
        },
        "apHccdEnabled" : {
            "description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
            "type" : "boolean",
            "default" : false
        },
        "apHccdPersist" : {
            "description" : "Allow Historical Connection Failures to be persisted.",
            "type" : "boolean",
            "default" : true
        },
        "myRuckusConfig" : {
            "description" : "My.Ruckus configuration",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "aclForTunnelWlanAndVlanEnable" : {
                    "description" : "My.Ruckus support for tunnel-wlan/vlan",
                    "type" : "boolean"
                }
            },
            "required" : [ "aclForTunnelWlanAndVlanEnable" ]
        },
        "apHttp2CertChkEnable" : {
            "type" : "boolean"
        },
        "bssColoringEnable" : {
            "description" : "Turn on/off BSS coloring mechanism.",
            "type" : "boolean",
            "default" : true
        },
        "radioConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "radio24g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gLower" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gUpper" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio6g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "lowPowerIndoorModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        },
                        "bssMinRate" : {
                            "description" : "6G BSS minimum rate (mbps)",
                            "type" : "string",
                            "enum" : [ "HE-MCS0", "HE-MCS1", "HE-MCS2", "HE-MCS3" ]
                        },
                        "mgmtTxRate" : {
                            "description" : "6G management TX rate (mbps)",
                            "type" : "string",
                            "enum" : [ "6 mbps", "9 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
                        },
                        "multicastUplinkRateLimit" : {
                            "description" : "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        },
                        "multicastDownlinkRateLimit" : {
                            "description" : "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        }
                    }
                },
                "dual5gEnabled" : {
                    "type" : "boolean"
                }
            }
        }
    },
    "required" : [ "name", "login" ]
}
Response  201
HideShow
Body
{
  "id": "zoneUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify entire zone

PUT/v11_1/rkszones/{id}

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

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "modifyZoneName",
  "description": "description Zone",
  "countryCode": "US",
  "timezone": {
    "systemTimezone": "America/Whitehorse"
  },
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "mesh": {
    "ssid": "meshSSID",
    "passphrase": "passphrase"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "syslog": {
    "address": "1.1.1.1",
    "port": 514,
    "facility": "Local0",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "nodeAffinityProfile": null,
  "venueProfile": null,
  "locationBasedService": null,
  "channelModeEnabled": false,
  "bonjourFencingPolicy": null,
  "tunnelType": "RuckusGRE",
  "tunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 10,
    "minClientThroughputMbps": 10
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 10,
    "minClientThroughputMbps": 10
  },
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "loadBalancing": {
    "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
    "clientLoadBalancing24": {
      "adjacentRadioThreshold": 12
    },
    "clientLoadBalancing50": {
      "adjacentRadioThreshold": 12
    },
    "bandBalancing": {
      "wifi24Percentage": 10
    },
    "steeringMode": "BASIC"
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "apLatencyInterval": {
    "pingEnabled": true
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": false,
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "dhcpSiteConfig": {
    "siteEnabled": true,
    "siteMode": "EnableOnEachAPs",
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "rogueApReportThreshold": 40,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingDetection": true,
  "rogueApJammingThreshold": 40,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "healthCheckSitesEnabled": true,
  "healthCheckSites": [
    "www.google.com",
    "www.live.com:443",
    "www.github.com:443",
    "source.codeaurora.org:443",
    "www.wikipedia.com"
  ],
  "ruckusGreTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "softGreTunnelProflies": [
    {
      "id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
      "name": "softGre1",
      "aaaAffinityEnabled": true
    },
    {
      "id": "7803e411-df53-11e7-98e1-08002748d78e",
      "name": "softGre2",
      "aaaAffinityEnabled": true
    }
  ],
  "ipsecProfiles": [
    {
      "id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
      "name": "ipsec1"
    }
  ],
  "sshTunnelEncryption": "AES128",
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [
            "B1",
            "B3",
            "B5"
          ],
          "channel3g": [
            "B5"
          ]
        }
      ]
    },
    {
      "simCardId": 1,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [],
          "channel3g": []
        }
      ]
    }
  ],
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "apHccdEnabled": true,
  "apHccdPersist": true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "timezone" : {
            "description" : "Time zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the 'Overview > Time Zone' list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "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)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "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)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network. Would be mandatory when the mesh is enabled.",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ]
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "syslogConfigType" : {
                    "description" : "Syslog configuration type.",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ]
                },
                "syslogServerProfileId" : {
                    "description" : "Syslog server profile ID.",
                    "type" : "string"
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "loadBalancing" : {
            "description" : "Load Balancing configuration of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "loadBalancingMethod" : {
                    "type" : "string",
                    "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
                },
                "bandBalancing" : {
                    "description" : "Band Balancing configuration of the zone.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "wifi24Percentage" : {
                            "description" : "Percentage of client load on 2.4GHz radio band",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        }
                    }
                },
                "steeringMode" : {
                    "description" : "Steering Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "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",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "AP latency interval",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean"
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "restrictedApAccessEnabled" : {
            "description" : "Enable Restricted AP Access of the zone.",
            "type" : "boolean"
        },
        "restrictedApAccessProfileId" : {
            "description" : "Restricted AP Access Profile Id of the zone.",
            "type" : "string"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Config in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "portSelectionEnabled" : {
                    "description" : "DHCP Port Selection Enabled",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpConfigType" : {
                    "description" : "The config type of SNMP",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SNMP_AGENT_PROFILE" ]
                },
                "apSnmpAgentProfileId" : {
                    "type" : "string"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "Custom recovery ssid passphrase. If passphrase has been customized, this property cannot be empty in the future. ",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone",
            "type" : "boolean"
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "description" : "Enable jamming detection.",
            "type" : "boolean"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "description" : "Directed multicast from wired client.",
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "description" : "Directed multicast from wireless.",
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "description" : "Directed multicast from network.",
            "type" : "boolean"
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean"
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "ipsecTunnelMode" : {
            "type" : "string",
            "enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
        },
        "rksGreForwardBroadcast" : {
            "description" : "Ruckus GRE tunnel broadcast packet forwarding",
            "type" : "boolean"
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ]
        },
        "lteBandLockChannels" : {
            "description" : "LTE band lock channels options",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "paloAltoFirewallProfileId" : {
            "type" : "string"
        },
        "apHccdEnabled" : {
            "description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
            "type" : "boolean"
        },
        "apHccdPersist" : {
            "description" : "Allow Historical Connection Failures to be persisted.",
            "type" : "boolean"
        },
        "aaaAffinityEnabled" : {
            "type" : "boolean"
        },
        "myRuckusConfig" : {
            "description" : "My.Ruckus configuration",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "aclForTunnelWlanAndVlanEnable" : {
                    "description" : "My.Ruckus support for tunnel-wlan/vlan",
                    "type" : "boolean"
                }
            },
            "required" : [ "aclForTunnelWlanAndVlanEnable" ]
        },
        "apHttp2CertChkEnable" : {
            "type" : "boolean"
        },
        "bssColoringEnable" : {
            "description" : "Turn on/off BSS coloring mechanism.",
            "type" : "boolean"
        },
        "radioConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "radio24g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gLower" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gUpper" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio6g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "lowPowerIndoorModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        },
                        "bssMinRate" : {
                            "description" : "6G BSS minimum rate (mbps)",
                            "type" : "string",
                            "enum" : [ "HE-MCS0", "HE-MCS1", "HE-MCS2", "HE-MCS3" ]
                        },
                        "mgmtTxRate" : {
                            "description" : "6G management TX rate (mbps)",
                            "type" : "string",
                            "enum" : [ "6 mbps", "9 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
                        },
                        "multicastUplinkRateLimit" : {
                            "description" : "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        },
                        "multicastDownlinkRateLimit" : {
                            "description" : "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        }
                    }
                },
                "dual5gEnabled" : {
                    "type" : "boolean"
                }
            }
        }
    }
}
Response  204

Modify AP Model

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

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

Request
HideShow
Body
{
  "ledStatusEnabled": true,
  "lacp": {
    "keepApSetting": false,
    "enabled": true,
    "bondPortProfileId": "ed395d1c-45a7-4d85-994f-244c38c83f2c"
  },
  "lldp": {
    "enabled": true,
    "advertiseIntervalInSec": 30,
    "holdTimeInSec": 120,
    "managementIPTLVEnabled": false
  },
  "cellularSettings": {
    "mobileAPName": "internet",
    "mobileAPName2": "internet",
    "simCardUsage": 0,
    "select3g4g": 0,
    "select3g4g2": 0,
    "dataRoaming": 1,
    "dataRoaming2": 1,
    "wanConnection": 0,
    "wanRecoveryTimer": 60
  },
  "ledMode": null,
  "internalHeaterEnabled": null,
  "poeOutPortEnabled": null,
  "usbPowerEnable": true,
  "poeModeSetting": "Auto",
  "poeTxChain": 2,
  "radioBand": null,
  "externalAntenna24": null,
  "externalAntenna50": null,
  "lanPorts": [
    {
      "portName": "LAN1",
      "enabled": false,
      "ethPortProfile": null
    },
    {
      "portName": "LAN2",
      "enabled": true,
      "ethPortProfile": {
        "id": "0",
        "name": "Default Trunk Port"
      }
    },
    {
      "portName": "LAN3",
      "enabled": true,
      "ethPortProfile": {
        "id": "1",
        "name": "Default Access Port"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ledStatusEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "lldp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "advertiseIntervalInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 300
        },
        "holdTimeInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 60,
          "maximum": 1200
        },
        "managementIPTLVEnabled": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lacp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "keepApSetting": {
          "type": "boolean"
        },
        "enabled": {
          "type": "boolean"
        },
        "bondPortProfileId": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "cellularSettings": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mobileAPName": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
        },
        "mobileAPName2": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
        },
        "simCardUsage": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 2
        },
        "select3g4g": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2
        },
        "select3g4g2": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2
        },
        "dataRoaming": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 1
        },
        "dataRoaming2": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 1
        },
        "wanConnection": {
          "type": "integer",
          "minimum": 0,
          "maximum": 3
        },
        "wanRecoveryTimer": {
          "type": "integer",
          "minimum": 10,
          "maximum": 300
        }
      },
      "required": [
        "select3g4g",
        "select3g4g2",
        "wanConnection",
        "wanRecoveryTimer"
      ]
    },
    "ledMode": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        null,
        "CableModem",
        "AccessPoint",
        "CableModem_AccessPoint",
        "CableModem_AccessPoint_DEFAULT",
        "ActiveSurgeProtector",
        "ActiveSurgeProtector_ModemOnline_DEFAULT",
        "Off"
      ]
    },
    "internalHeaterEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeOutPortEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "usbPowerEnable": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeModeSetting": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "Auto",
        "_802_3af",
        "_802_3at",
        "_802_3atPlus",
        "_802_3bt_Class_5",
        "_802_3bt_Class_6",
        "_802_3bt_Class_7",
        "_802_3bt_Class_8",
        null
      ]
    },
    "poeTxChain": {
      "description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
      "type": [
        "integer",
        "null"
      ]
    },
    "radioBand": {
      "description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
      "type": [
        "string",
        "null"
      ],
      "enum": [
        null,
        "2.4GHz",
        "5GHz"
      ]
    },
    "externalAntenna24": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "dbi": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 90
        },
        "chainMask": {
          "type": [
            "string",
            "null"
          ],
          "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": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            null,
            "Two",
            "Three"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lanPorts": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "portName": {
            "type": "string",
            "enum": [
              "LAN1",
              "LAN2",
              "LAN3",
              "LAN4",
              "LAN5"
            ]
          },
          "enabled": {
            "type": "boolean"
          },
          "ethPortProfile": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "portName",
          "enabled"
        ]
      }
    }
  }
}
Response  204

Change AP Firmware

PUT/v11_1/rkszones/{zoneId}/apFirmware

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

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

Modify

PATCH/v11_1/rkszones/{id}

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

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "modifyZoneName",
  "description": "description Zone",
  "countryCode": "US",
  "timezone": {
    "systemTimezone": "America/Whitehorse"
  },
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "mesh": {
    "ssid": "meshSSID",
    "passphrase": "passphrase"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "syslog": {
    "address": "1.1.1.1",
    "port": 514,
    "facility": "Local0",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "nodeAffinityProfile": null,
  "venueProfile": null,
  "locationBasedService": null,
  "channelModeEnabled": false,
  "bonjourFencingPolicy": null,
  "tunnelType": "RuckusGRE",
  "tunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 10,
    "minClientThroughputMbps": 10
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 10,
    "minClientThroughputMbps": 10
  },
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "loadBalancing": {
    "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
    "clientLoadBalancing24": {
      "adjacentRadioThreshold": 12
    },
    "clientLoadBalancing50": {
      "adjacentRadioThreshold": 12
    },
    "bandBalancing": {
      "wifi24Percentage": 10
    },
    "steeringMode": "BASIC"
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "apLatencyInterval": {
    "pingEnabled": true
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": false,
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "dhcpSiteConfig": {
    "siteEnabled": true,
    "siteMode": "EnableOnEachAPs",
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "rogueApReportThreshold": 40,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingDetection": true,
  "rogueApJammingThreshold": 40,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "healthCheckSitesEnabled": true,
  "healthCheckSites": [
    "www.google.com",
    "www.live.com:443",
    "www.github.com:443",
    "source.codeaurora.org:443",
    "www.wikipedia.com"
  ],
  "ruckusGreTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "softGreTunnelProflies": [
    {
      "id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
      "name": "softGre1",
      "aaaAffinityEnabled": true
    },
    {
      "id": "7803e411-df53-11e7-98e1-08002748d78e",
      "name": "softGre2",
      "aaaAffinityEnabled": true
    }
  ],
  "ipsecProfiles": [
    {
      "id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
      "name": "ipsec1"
    }
  ],
  "sshTunnelEncryption": "AES128",
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [
            "B1",
            "B3",
            "B5"
          ],
          "channel3g": [
            "B5"
          ]
        }
      ]
    },
    {
      "simCardId": 1,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [],
          "channel3g": []
        }
      ]
    }
  ],
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "apHccdEnabled": true,
  "apHccdPersist": true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "timezone" : {
            "description" : "Time zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the 'Overview > Time Zone' list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "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)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "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)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network. Would be mandatory when the mesh is enabled.",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ]
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "syslogConfigType" : {
                    "description" : "Syslog configuration type.",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ]
                },
                "syslogServerProfileId" : {
                    "description" : "Syslog server profile ID.",
                    "type" : "string"
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "loadBalancing" : {
            "description" : "Load Balancing configuration of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "loadBalancingMethod" : {
                    "type" : "string",
                    "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
                },
                "bandBalancing" : {
                    "description" : "Band Balancing configuration of the zone.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "wifi24Percentage" : {
                            "description" : "Percentage of client load on 2.4GHz radio band",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        }
                    }
                },
                "steeringMode" : {
                    "description" : "Steering Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "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",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "AP latency interval",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean"
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "restrictedApAccessEnabled" : {
            "description" : "Enable Restricted AP Access of the zone.",
            "type" : "boolean"
        },
        "restrictedApAccessProfileId" : {
            "description" : "Restricted AP Access Profile Id of the zone.",
            "type" : "string"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Config in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "portSelectionEnabled" : {
                    "description" : "DHCP Port Selection Enabled",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpConfigType" : {
                    "description" : "The config type of SNMP",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SNMP_AGENT_PROFILE" ]
                },
                "apSnmpAgentProfileId" : {
                    "type" : "string"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "Custom recovery ssid passphrase. If passphrase has been customized, this property cannot be empty in the future. ",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone",
            "type" : "boolean"
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "description" : "Enable jamming detection.",
            "type" : "boolean"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "description" : "Directed multicast from wired client.",
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "description" : "Directed multicast from wireless.",
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "description" : "Directed multicast from network.",
            "type" : "boolean"
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean"
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "ipsecTunnelMode" : {
            "type" : "string",
            "enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
        },
        "rksGreForwardBroadcast" : {
            "description" : "Ruckus GRE tunnel broadcast packet forwarding",
            "type" : "boolean"
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ]
        },
        "lteBandLockChannels" : {
            "description" : "LTE band lock channels options",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "paloAltoFirewallProfileId" : {
            "type" : "string"
        },
        "apHccdEnabled" : {
            "description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
            "type" : "boolean"
        },
        "apHccdPersist" : {
            "description" : "Allow Historical Connection Failures to be persisted.",
            "type" : "boolean"
        },
        "aaaAffinityEnabled" : {
            "type" : "boolean"
        },
        "myRuckusConfig" : {
            "description" : "My.Ruckus configuration",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "aclForTunnelWlanAndVlanEnable" : {
                    "description" : "My.Ruckus support for tunnel-wlan/vlan",
                    "type" : "boolean"
                }
            },
            "required" : [ "aclForTunnelWlanAndVlanEnable" ]
        },
        "apHttp2CertChkEnable" : {
            "type" : "boolean"
        },
        "bssColoringEnable" : {
            "description" : "Turn on/off BSS coloring mechanism.",
            "type" : "boolean"
        },
        "radioConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "radio24g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gLower" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gUpper" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio6g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "lowPowerIndoorModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        },
                        "bssMinRate" : {
                            "description" : "6G BSS minimum rate (mbps)",
                            "type" : "string",
                            "enum" : [ "HE-MCS0", "HE-MCS1", "HE-MCS2", "HE-MCS3" ]
                        },
                        "mgmtTxRate" : {
                            "description" : "6G management TX rate (mbps)",
                            "type" : "string",
                            "enum" : [ "6 mbps", "9 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
                        },
                        "multicastUplinkRateLimit" : {
                            "description" : "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        },
                        "multicastDownlinkRateLimit" : {
                            "description" : "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        }
                    }
                },
                "dual5gEnabled" : {
                    "type" : "boolean"
                }
            }
        }
    }
}
Response  204

Clear Mesh Configuration

DELETE/v11_1/rkszones/{id}/mesh

Use this API command to disable mesh networking.

Response  204

Disable Syslog

DELETE/v11_1/rkszones/{id}/syslog

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

Response  204

Disable Smart Monitor

DELETE/v11_1/rkszones/{id}/smartMonitor

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

Response  204

Disable Client Admission Control 2.4G

DELETE/v11_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

Disable Client Admission Control 5G

DELETE/v11_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

Disable Client Load Balancing 2.4G

DELETE/v11_1/rkszones/{id}/loadBalancing/clientLoadBalancing24

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

Response  204

Disable Client Load Balancing 5G

DELETE/v11_1/rkszones/{id}/loadBalancing/clientLoadBalancing50

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

Response  204

Disable Band Balancing

DELETE/v11_1/rkszones/{id}/loadBalancing/bandBalancing

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

Response  204

Clear Hotspot2.0 Venue Profile

DELETE/v11_1/rkszones/{id}/venueProfile

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

Response  204

Disable Rogue

DELETE/v11_1/rkszones/{id}/rogue

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

Response  204

Disable Location Based Service

DELETE/v11_1/rkszones/{id}/locationBasedService

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

Response  204

Disable Altitude

DELETE/v11_1/rkszones/{id}/altitude

Use this API command to disable altitude configuration of zone.

Response  204

Clear AP SNMP Options

DELETE/v11_1/rkszones/{id}/snmpAgent

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

Response  204

Clear zone recovery SSID

DELETE/v11_1/rkszones/{id}/recoverySsid

Use this API command to clear recovery ssid setting of a zone.

Response  204

Follow System Time Zone

DELETE/v11_1/rkszones/{id}/timezone

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

Response  204

Disable Background Scanning 2.4G

DELETE/v11_0/rkszones/{id}/backgroundScanning24

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Background Scanning 5G

DELETE/v11_0/rkszones/{id}/backgroundScanning50

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Background Scanning 2.4G

DELETE/v11_1/rkszones/{id}/radioConfig/radio24g/backgroundScanning

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

Response  204

Disable Background Scanning 5G

DELETE/v11_1/rkszones/{id}/radioConfig/radio5g/backgroundScanning

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

Response  204

Disable Background Scanning Radio Lower 5G

DELETE/v11_1/rkszones/{id}/radioConfig/radio5gLower/backgroundScanning

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

Response  204

Disable Background Scanning Radio Upper 5G

DELETE/v11_1/rkszones/{id}/radioConfig/radio5gUpper/backgroundScanning

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

Response  204

Disable Background Scanning 6G

DELETE/v11_1/rkszones/{id}/radioConfig/radio6g/backgroundScanning

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

Response  204

Disable Load Balancing

DELETE/v11_1/rkszones/{id}/loadBalancing

Use this API command to disable overall load balancing configuration for APs that belong to a zone.

Response  204

Delete IPsec Profiles

DELETE/v11_1/rkszones/{id}/softGreTunnelProflies

Use this API command to Delete IPsec profiles.

Response  204

Delete IPsec Profiles

DELETE/v11_1/rkszones/{id}/ipsecProfiles

Use this API command to Delete IPsec profiles.

Response  204

Delete

DELETE/v11_1/rkszones/{id}

Use this API command to delete a zone.

Response  204

AP Group

Retrieve List

GET/v11_1/rkszones/{zoneId}/apgroups

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

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

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

Retrieve

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

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

Response  200
HideShow
Body
{
  "id": "apGroupUUID",
  "zoneId": "zoneUUID",
  "name": "apGroupName",
  "description": "apGroupDescription",
  "location": "test-ap1_modify",
  "locationAdditionalInfo": "add",
  "latitude": 34,
  "longitude": 45,
  "radioConfig": {
    "radio24g": {
      "autoCellSizing": null,
      "txPower": "-5dB",
      "channelWidth": 40,
      "channel": 5,
      "channelRange": [
        1,
        2,
        3,
        4,
        5,
        6
      ],
      "availableChannelRange": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11
      ],
      "wlanGroupId": "ab6d94c2-b2f1-11eb-8d09-1e8abc5ea883",
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      },
      "protectionMode": "CTS_ONLY"
    },
    "radio5g": {
      "autoCellSizing": null,
      "txPower": "-5dB",
      "channelWidth": 20,
      "channel": 157,
      "channelRange": [
        157,
        161
      ],
      "availableChannelRange": [
        36,
        40,
        44,
        48,
        149,
        153,
        157,
        161,
        165
      ],
      "secondaryChannel": 0,
      "channelIndoor": 36,
      "secondaryChannelIndoor": 0,
      "channelRangeIndoor": [
        36,
        40,
        44,
        48,
        157,
        161
      ],
      "availableChannelRangeIndoor": [
        36,
        40,
        44,
        48,
        149,
        153,
        157,
        161,
        165
      ],
      "wlanGroupId": null,
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      }
    },
    "radio5gUpper": {
      "autoCellSizing": null,
      "txPower": null,
      "channelWidth": null,
      "channel": null,
      "channelRange": null,
      "availableChannelRange": [
        149,
        153,
        157,
        161,
        165
      ],
      "secondaryChannel": 0,
      "channelIndoor": null,
      "secondaryChannelIndoor": 0,
      "channelRangeIndoor": null,
      "availableChannelRangeIndoor": [
        149,
        153,
        157,
        161,
        165
      ],
      "wlanGroupId": null,
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      }
    },
    "radio5gLower": {
      "autoCellSizing": null,
      "txPower": null,
      "channelWidth": null,
      "channel": null,
      "channelRange": null,
      "availableChannelRange": [
        36,
        40,
        44,
        48
      ],
      "secondaryChannel": 0,
      "channelIndoor": null,
      "secondaryChannelIndoor": 0,
      "channelRangeIndoor": null,
      "availableChannelRangeIndoor": [
        36,
        40,
        44,
        48
      ],
      "wlanGroupId": null,
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      }
    },
    "radio6g": {
      "autoCellSizing": null,
      "txPower": null,
      "channelWidth": null,
      "channel": null,
      "channelRange": null,
      "availableChannelRange": [
        1,
        5,
        9,
        13,
        17,
        21,
        25,
        29,
        33,
        37,
        41,
        45,
        49,
        53,
        57,
        61,
        65,
        69,
        73,
        77,
        81,
        85,
        89,
        93,
        97,
        101,
        105,
        109,
        113,
        117,
        121,
        125,
        129,
        133,
        137,
        141,
        145,
        149,
        153,
        157,
        161,
        165,
        169,
        173,
        177,
        181,
        185,
        189,
        193,
        197,
        201,
        205,
        209,
        213,
        217,
        221,
        225,
        229,
        223
      ],
      "wlanGroupId": null,
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      },
      "bssMinRate": "HE-MCS0",
      "mgmtTxRate": "6 mbps",
      "multicastUplinkRateLimit": 3,
      "multicastDownlinkRateLimit": 3
    },
    "dual5gEnabled": null
  },
  "locationBasedService": null,
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "clientAdmissionControl50": null,
  "venueProfile": null,
  "members": [
    {
      "apMac": "00:11:22:33:44:55"
    },
    {
      "apMac": "11:22:33:44:55:66"
    }
  ],
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "rogueApReportThreshold": 30,
  "rogueApAggressivenessMode": 1,
  "rogueApJammingThreshold": 30,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "monitoringEnabled": false,
  "rogueScanFreq": "LOW",
  "paloAltoFirewallProfileOverrided": true,
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the AP group",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone to which the AP group belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the AP group",
      "type": "string"
    },
    "description": {
      "description": "Description of the AP group",
      "type": "string"
    },
    "location": {
      "description": "Location of the AP group.",
      "type": "string"
    },
    "locationAdditionalInfo": {
      "description": "Location additional info of the AP group.",
      "type": "string"
    },
    "altitude": {
      "description": "GPS Altitude",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "altitudeUnit": {
          "description": "altitude unit",
          "type": "string",
          "enum": [
            "meters",
            "floor"
          ],
          "default": "meters"
        },
        "altitudeValue": {
          "description": "altitude value",
          "type": "integer"
        }
      }
    },
    "latitude": {
      "description": "Latitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "longitude": {
      "description": "Longitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "locationBasedService": {
      "description": "Location based service configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "clientAdmissionControl24": {
      "description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "default": 75,
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "default": 10,
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "default": 0,
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "clientAdmissionControl50": {
      "description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "default": 75,
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "default": 10,
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "default": 0,
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "snmpAgent": {
      "description": "SNMP Agent",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "apSnmpEnabled": {
          "description": "Enable AP SNMP",
          "type": "boolean"
        },
        "snmpConfigType": {
          "description": "The config type of SNMP",
          "type": "string",
          "enum": [
            "CUSTOM",
            "AP_SNMP_AGENT_PROFILE"
          ],
          "default": "CUSTOM"
        },
        "apSnmpAgentProfileId": {
          "type": "string"
        },
        "snmpV2Agent": {
          "description": "Community List of the SNMP V2 Agent.",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "communityName": {
                "description": "name of the SNMP Community.",
                "type": "string"
              },
              "readEnabled": {
                "description": "read privilege of the SNMP Coummunity",
                "type": "boolean"
              },
              "writeEnabled": {
                "description": "write privilege of the SNMP Coummunity",
                "type": "boolean"
              },
              "notificationEnabled": {
                "description": "notification privilege of the SNMP Coummunity",
                "type": "boolean"
              },
              "notificationType": {
                "description": "type of the notification privilege",
                "type": "string",
                "enum": [
                  "TRAP",
                  "INFORM"
                ]
              },
              "notificationTarget": {
                "description": "Trap List of the SNMP Coummunity",
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "address": {
                      "description": "address of the SNMP Trap",
                      "type": "string"
                    },
                    "port": {
                      "description": "port number of the SNMP Trap",
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 65535
                    }
                  },
                  "required": [
                    "address",
                    "port"
                  ]
                }
              }
            },
            "required": [
              "communityName",
              "readEnabled",
              "writeEnabled",
              "notificationEnabled"
            ]
          }
        },
        "snmpV3Agent": {
          "description": "User List of the SNMP V3 Agent.",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "userName": {
                "description": "name of the SNMP User.",
                "type": "string"
              },
              "authProtocol": {
                "description": "authProtocol of the SNMP User.",
                "type": "string",
                "enum": [
                  "NONE",
                  "MD5",
                  "SHA"
                ]
              },
              "authPassword": {
                "description": "authPassword of the SNMP User.",
                "type": "string",
                "minLength": 8
              },
              "privProtocol": {
                "description": "privProtocol of the SNMP User.",
                "type": "string",
                "enum": [
                  "NONE",
                  "DES",
                  "AES"
                ]
              },
              "privPassword": {
                "description": "privPassword of the SNMP User.",
                "type": "string",
                "minLength": 8
              },
              "readEnabled": {
                "description": "read privilege of the SNMP User",
                "type": "boolean"
              },
              "writeEnabled": {
                "description": "write privilege of the SNMP User",
                "type": "boolean"
              },
              "notificationEnabled": {
                "description": "notification privilege of the SNMP User",
                "type": "boolean"
              },
              "notificationType": {
                "description": "type of the notification privilege",
                "type": "string",
                "enum": [
                  "TRAP",
                  "INFORM"
                ]
              },
              "notificationTarget": {
                "description": "Trap List of the SNMP User",
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "address": {
                      "description": "address of the SNMP Trap",
                      "type": "string"
                    },
                    "port": {
                      "description": "port number of the SNMP Trap",
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 65535
                    }
                  },
                  "required": [
                    "address",
                    "port"
                  ]
                }
              }
            },
            "required": [
              "userName",
              "readEnabled",
              "writeEnabled",
              "notificationEnabled"
            ]
          }
        }
      }
    },
    "venueProfile": {
      "description": "Venue profile configuration of the AP group.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "members": {
      "description": "Members of the AP group",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "apMac": {
            "description": "MAC address of member AP",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "apSerial": {
            "description": "Serial number of member AP",
            "type": "string"
          }
        }
      }
    },
    "channelEvaluationInterval": {
      "description": "channel evaluation Interval of the ap group",
      "type": "integer",
      "default": 600,
      "minimum": 60,
      "maximum": 3600
    },
    "apMgmtVlan": {
      "description": "ap Management Vlan of the apgroup",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mode": {
          "description": "Vlan Mode of the zone",
          "type": "string",
          "enum": [
            "KEEP",
            "USER_DEFINED"
          ],
          "default": "KEEP"
        },
        "id": {
          "description": "Vlan id of the zone",
          "type": "integer",
          "default": "1"
        }
      }
    },
    "recoverySsid": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "recoverySsidEnabled": {
          "description": "recovery ssid enable/disable",
          "type": "boolean"
        }
      }
    },
    "rogueApReportThreshold": {
      "description": "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
      "type": "integer"
    },
    "rogueApAggressivenessMode": {
      "description": "Adjust the frequency interval to de-authenticate rogue APs.",
      "type": "integer"
    },
    "rogueApJammingThreshold": {
      "type": "integer"
    },
    "directedMulticastFromWiredClientEnabled": {
      "type": "boolean"
    },
    "directedMulticastFromWirelessClientEnabled": {
      "type": "boolean"
    },
    "directedMulticastFromNetworkEnabled": {
      "type": "boolean"
    },
    "lteBandLockChannels": {
      "description": "LTE band lock channels options",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "simCardId": {
            "description": "SIM card ID(Primary:0, Secondary:1)",
            "type": "integer"
          },
          "type": {
            "description": "LTE chipset SKU type",
            "type": "string"
          },
          "channel4g": {
            "description": "LTE 4G channels",
            "type": "string"
          },
          "channel3g": {
            "description": "LTE 3G channels",
            "type": "string"
          }
        }
      }
    },
    "monitoringEnabled": {
      "description": "Set AP group as monitoring group.",
      "type": "boolean"
    },
    "apGroupRoguePolicy": {
      "description": "Override Rogue AP policy ID (only for monitoring group).",
      "type": "string"
    },
    "rogueScanFreq": {
      "description": "Set rogue scan frequency (only for monitoring group).",
      "type": "string",
      "enum": [
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    },
    "paloAltoFirewallProfileOverrided": {
      "type": "boolean"
    },
    "paloAltoFirewallProfileId": {
      "type": "string"
    },
    "rksGreForwardBroadcast": {
      "description": "Ruckus GRE tunnel broadcast packet forwarding",
      "type": "boolean"
    },
    "bssColoringEnable": {
      "description": "BSS coloring mechanism enabled.",
      "type": "boolean"
    },
    "radioConfig": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "radio24g": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ],
              "default": "Full"
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40
              ],
              "default": 0
            },
            "channel": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "availableChannelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "wlanGroupId": {
              "type": "string"
            },
            "wlanServiceEnabled": {
              "type": "boolean"
            },
            "protectionMode": {
              "type": "string",
              "enum": [
                "NONE",
                "CTS_ONLY",
                "RTS_CTS"
              ],
              "default": "RTS_CTS"
            },
            "backgroundScanning": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "frequencyInSec": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535,
                  "default": 20
                }
              },
              "required": [
                "frequencyInSec"
              ]
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ],
                  "default": "BackgroundScanning"
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "default": 480,
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "default": 33,
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio5g": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ],
              "default": "Full"
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ],
              "default": 0
            },
            "channel": {
              "type": "integer"
            },
            "channelIndoor": {
              "type": "integer"
            },
            "secondaryChannel": {
              "type": "integer"
            },
            "secondaryChannelIndoor": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "channelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "dfsChannelEnabled": {
              "type": "boolean"
            },
            "cbandChannelEnabled": {
              "type": "boolean"
            },
            "cbandChannelLicenseEnabled": {
              "type": "boolean"
            },
            "channel144Enabled": {
              "type": "boolean"
            },
            "channelModeEnabled": {
              "type": "boolean"
            },
            "availableChannelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "availableChannelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "wlanGroupId": {
              "type": "string"
            },
            "protectionMode": {
              "type": "string",
              "enum": [
                "NONE",
                "CTS_ONLY",
                "RTS_CTS"
              ],
              "default": "RTS_CTS"
            },
            "backgroundScanning": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "frequencyInSec": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535,
                  "default": 20
                }
              },
              "required": [
                "frequencyInSec"
              ]
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ],
                  "default": "BackgroundScanning"
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "default": 480,
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "default": 33,
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio5gUpper": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ],
              "default": "Full"
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ],
              "default": 0
            },
            "channel": {
              "type": "integer"
            },
            "channelIndoor": {
              "type": "integer"
            },
            "secondaryChannel": {
              "type": "integer"
            },
            "secondaryChannelIndoor": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "channelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "dfsChannelEnabled": {
              "type": "boolean"
            },
            "cbandChannelEnabled": {
              "type": "boolean"
            },
            "cbandChannelLicenseEnabled": {
              "type": "boolean"
            },
            "channel144Enabled": {
              "type": "boolean"
            },
            "channelModeEnabled": {
              "type": "boolean"
            },
            "availableChannelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "availableChannelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "wlanGroupId": {
              "type": "string"
            },
            "protectionMode": {
              "type": "string",
              "enum": [
                "NONE",
                "CTS_ONLY",
                "RTS_CTS"
              ],
              "default": "RTS_CTS"
            },
            "backgroundScanning": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "frequencyInSec": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535,
                  "default": 20
                }
              },
              "required": [
                "frequencyInSec"
              ]
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ],
                  "default": "BackgroundScanning"
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "default": 480,
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "default": 33,
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio5gLower": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ],
              "default": "Full"
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ],
              "default": 0
            },
            "channel": {
              "type": "integer"
            },
            "channelIndoor": {
              "type": "integer"
            },
            "secondaryChannel": {
              "type": "integer"
            },
            "secondaryChannelIndoor": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "channelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "dfsChannelEnabled": {
              "type": "boolean"
            },
            "cbandChannelEnabled": {
              "type": "boolean"
            },
            "cbandChannelLicenseEnabled": {
              "type": "boolean"
            },
            "channel144Enabled": {
              "type": "boolean"
            },
            "channelModeEnabled": {
              "type": "boolean"
            },
            "availableChannelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "availableChannelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "wlanGroupId": {
              "type": "string"
            },
            "protectionMode": {
              "type": "string",
              "enum": [
                "NONE",
                "CTS_ONLY",
                "RTS_CTS"
              ],
              "default": "RTS_CTS"
            },
            "backgroundScanning": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "frequencyInSec": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535,
                  "default": 20
                }
              },
              "required": [
                "frequencyInSec"
              ]
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ],
                  "default": "BackgroundScanning"
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "default": 480,
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "default": 33,
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio6g": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ],
              "default": "Full"
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ],
              "default": 0
            },
            "channel": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "lowPowerIndoorModeEnabled": {
              "type": "boolean"
            },
            "availableChannelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "wlanGroupId": {
              "type": "string"
            },
            "wlanServiceEnabled": {
              "type": "boolean"
            },
            "protectionMode": {
              "type": "string",
              "enum": [
                "NONE",
                "CTS_ONLY",
                "RTS_CTS"
              ],
              "default": "RTS_CTS"
            },
            "backgroundScanning": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "frequencyInSec": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535,
                  "default": 20
                }
              },
              "required": [
                "frequencyInSec"
              ]
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ],
                  "default": "BackgroundScanning"
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "default": 480,
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "default": 33,
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            },
            "bssMinRate": {
              "description": "6G BSS minimum rate (mbps)",
              "type": "string",
              "enum": [
                "HE-MCS0",
                "HE-MCS1",
                "HE-MCS2",
                "HE-MCS3"
              ]
            },
            "mgmtTxRate": {
              "description": "6G management TX rate (mbps)",
              "type": "string",
              "enum": [
                "6 mbps",
                "9 mbps",
                "12 mbps",
                "18 mbps",
                "24 mbps",
                "36 mbps",
                "48 mbps",
                "54 mbps"
              ]
            },
            "multicastUplinkRateLimit": {
              "description": "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
              "type": "integer",
              "minimum": 0,
              "maximum": 100
            },
            "multicastDownlinkRateLimit": {
              "description": "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
              "type": "integer",
              "minimum": 0,
              "maximum": 100
            }
          }
        },
        "dual5gEnabled": {
          "type": "boolean"
        }
      }
    }
  },
  "required": [
    "name"
  ]
}

Retrieve Default AP Group

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

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

Response  200
HideShow
Body
{
  "id": "apGroupUUID",
  "zoneId": "zoneUUID",
  "name": "apGroupName",
  "description": "apGroupDescription",
  "location": "test-ap1_modify",
  "locationAdditionalInfo": "add",
  "latitude": 34,
  "longitude": 45,
  "radioConfig": {
    "radio24g": {
      "autoCellSizing": null,
      "txPower": "-5dB",
      "channelWidth": 40,
      "channel": 5,
      "channelRange": [
        1,
        2,
        3,
        4,
        5,
        6
      ],
      "availableChannelRange": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11
      ],
      "wlanGroupId": "ab6d94c2-b2f1-11eb-8d09-1e8abc5ea883",
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      },
      "protectionMode": "CTS_ONLY"
    },
    "radio5g": {
      "autoCellSizing": null,
      "txPower": "-5dB",
      "channelWidth": 20,
      "channel": 157,
      "channelRange": [
        157,
        161
      ],
      "availableChannelRange": [
        36,
        40,
        44,
        48,
        149,
        153,
        157,
        161,
        165
      ],
      "secondaryChannel": 0,
      "channelIndoor": 36,
      "secondaryChannelIndoor": 0,
      "channelRangeIndoor": [
        36,
        40,
        44,
        48,
        157,
        161
      ],
      "availableChannelRangeIndoor": [
        36,
        40,
        44,
        48,
        149,
        153,
        157,
        161,
        165
      ],
      "wlanGroupId": null,
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      }
    },
    "radio5gUpper": {
      "autoCellSizing": null,
      "txPower": null,
      "channelWidth": null,
      "channel": null,
      "channelRange": null,
      "availableChannelRange": [
        149,
        153,
        157,
        161,
        165
      ],
      "secondaryChannel": 0,
      "channelIndoor": null,
      "secondaryChannelIndoor": 0,
      "channelRangeIndoor": null,
      "availableChannelRangeIndoor": [
        149,
        153,
        157,
        161,
        165
      ],
      "wlanGroupId": null,
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      }
    },
    "radio5gLower": {
      "autoCellSizing": null,
      "txPower": null,
      "channelWidth": null,
      "channel": null,
      "channelRange": null,
      "availableChannelRange": [
        36,
        40,
        44,
        48
      ],
      "secondaryChannel": 0,
      "channelIndoor": null,
      "secondaryChannelIndoor": 0,
      "channelRangeIndoor": null,
      "availableChannelRangeIndoor": [
        36,
        40,
        44,
        48
      ],
      "wlanGroupId": null,
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      }
    },
    "radio6g": {
      "autoCellSizing": null,
      "txPower": null,
      "channelWidth": null,
      "channel": null,
      "channelRange": null,
      "availableChannelRange": [
        1,
        5,
        9,
        13,
        17,
        21,
        25,
        29,
        33,
        37,
        41,
        45,
        49,
        53,
        57,
        61,
        65,
        69,
        73,
        77,
        81,
        85,
        89,
        93,
        97,
        101,
        105,
        109,
        113,
        117,
        121,
        125,
        129,
        133,
        137,
        141,
        145,
        149,
        153,
        157,
        161,
        165,
        169,
        173,
        177,
        181,
        185,
        189,
        193,
        197,
        201,
        205,
        209,
        213,
        217,
        221,
        225,
        229,
        223
      ],
      "wlanGroupId": null,
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      },
      "bssMinRate": "HE-MCS0",
      "mgmtTxRate": "6 mbps",
      "multicastUplinkRateLimit": 3,
      "multicastDownlinkRateLimit": 3
    },
    "dual5gEnabled": null
  },
  "locationBasedService": null,
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "clientAdmissionControl50": null,
  "venueProfile": null,
  "members": [
    {
      "apMac": "00:11:22:33:44:55"
    },
    {
      "apMac": "11:22:33:44:55:66"
    }
  ],
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "rogueApReportThreshold": 30,
  "rogueApAggressivenessMode": 1,
  "rogueApJammingThreshold": 30,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "monitoringEnabled": false,
  "rogueScanFreq": "LOW",
  "paloAltoFirewallProfileOverrided": true,
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the AP group",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone to which the AP group belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the AP group",
      "type": "string"
    },
    "description": {
      "description": "Description of the AP group",
      "type": "string"
    },
    "location": {
      "description": "Location of the AP group.",
      "type": "string"
    },
    "locationAdditionalInfo": {
      "description": "Location additional info of the AP group.",
      "type": "string"
    },
    "altitude": {
      "description": "GPS Altitude",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "altitudeUnit": {
          "description": "altitude unit",
          "type": "string",
          "enum": [
            "meters",
            "floor"
          ],
          "default": "meters"
        },
        "altitudeValue": {
          "description": "altitude value",
          "type": "integer"
        }
      }
    },
    "latitude": {
      "description": "Latitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "longitude": {
      "description": "Longitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "locationBasedService": {
      "description": "Location based service configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "clientAdmissionControl24": {
      "description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "default": 75,
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "default": 10,
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "default": 0,
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "clientAdmissionControl50": {
      "description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "default": 75,
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "default": 10,
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "default": 0,
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "snmpAgent": {
      "description": "SNMP Agent",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "apSnmpEnabled": {
          "description": "Enable AP SNMP",
          "type": "boolean"
        },
        "snmpConfigType": {
          "description": "The config type of SNMP",
          "type": "string",
          "enum": [
            "CUSTOM",
            "AP_SNMP_AGENT_PROFILE"
          ],
          "default": "CUSTOM"
        },
        "apSnmpAgentProfileId": {
          "type": "string"
        },
        "snmpV2Agent": {
          "description": "Community List of the SNMP V2 Agent.",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "communityName": {
                "description": "name of the SNMP Community.",
                "type": "string"
              },
              "readEnabled": {
                "description": "read privilege of the SNMP Coummunity",
                "type": "boolean"
              },
              "writeEnabled": {
                "description": "write privilege of the SNMP Coummunity",
                "type": "boolean"
              },
              "notificationEnabled": {
                "description": "notification privilege of the SNMP Coummunity",
                "type": "boolean"
              },
              "notificationType": {
                "description": "type of the notification privilege",
                "type": "string",
                "enum": [
                  "TRAP",
                  "INFORM"
                ]
              },
              "notificationTarget": {
                "description": "Trap List of the SNMP Coummunity",
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "address": {
                      "description": "address of the SNMP Trap",
                      "type": "string"
                    },
                    "port": {
                      "description": "port number of the SNMP Trap",
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 65535
                    }
                  },
                  "required": [
                    "address",
                    "port"
                  ]
                }
              }
            },
            "required": [
              "communityName",
              "readEnabled",
              "writeEnabled",
              "notificationEnabled"
            ]
          }
        },
        "snmpV3Agent": {
          "description": "User List of the SNMP V3 Agent.",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "userName": {
                "description": "name of the SNMP User.",
                "type": "string"
              },
              "authProtocol": {
                "description": "authProtocol of the SNMP User.",
                "type": "string",
                "enum": [
                  "NONE",
                  "MD5",
                  "SHA"
                ]
              },
              "authPassword": {
                "description": "authPassword of the SNMP User.",
                "type": "string",
                "minLength": 8
              },
              "privProtocol": {
                "description": "privProtocol of the SNMP User.",
                "type": "string",
                "enum": [
                  "NONE",
                  "DES",
                  "AES"
                ]
              },
              "privPassword": {
                "description": "privPassword of the SNMP User.",
                "type": "string",
                "minLength": 8
              },
              "readEnabled": {
                "description": "read privilege of the SNMP User",
                "type": "boolean"
              },
              "writeEnabled": {
                "description": "write privilege of the SNMP User",
                "type": "boolean"
              },
              "notificationEnabled": {
                "description": "notification privilege of the SNMP User",
                "type": "boolean"
              },
              "notificationType": {
                "description": "type of the notification privilege",
                "type": "string",
                "enum": [
                  "TRAP",
                  "INFORM"
                ]
              },
              "notificationTarget": {
                "description": "Trap List of the SNMP User",
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "address": {
                      "description": "address of the SNMP Trap",
                      "type": "string"
                    },
                    "port": {
                      "description": "port number of the SNMP Trap",
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 65535
                    }
                  },
                  "required": [
                    "address",
                    "port"
                  ]
                }
              }
            },
            "required": [
              "userName",
              "readEnabled",
              "writeEnabled",
              "notificationEnabled"
            ]
          }
        }
      }
    },
    "venueProfile": {
      "description": "Venue profile configuration of the AP group.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "members": {
      "description": "Members of the AP group",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "apMac": {
            "description": "MAC address of member AP",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "apSerial": {
            "description": "Serial number of member AP",
            "type": "string"
          }
        }
      }
    },
    "channelEvaluationInterval": {
      "description": "channel evaluation Interval of the ap group",
      "type": "integer",
      "default": 600,
      "minimum": 60,
      "maximum": 3600
    },
    "apMgmtVlan": {
      "description": "ap Management Vlan of the apgroup",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mode": {
          "description": "Vlan Mode of the zone",
          "type": "string",
          "enum": [
            "KEEP",
            "USER_DEFINED"
          ],
          "default": "KEEP"
        },
        "id": {
          "description": "Vlan id of the zone",
          "type": "integer",
          "default": "1"
        }
      }
    },
    "recoverySsid": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "recoverySsidEnabled": {
          "description": "recovery ssid enable/disable",
          "type": "boolean"
        }
      }
    },
    "rogueApReportThreshold": {
      "description": "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
      "type": "integer"
    },
    "rogueApAggressivenessMode": {
      "description": "Adjust the frequency interval to de-authenticate rogue APs.",
      "type": "integer"
    },
    "rogueApJammingThreshold": {
      "type": "integer"
    },
    "directedMulticastFromWiredClientEnabled": {
      "type": "boolean"
    },
    "directedMulticastFromWirelessClientEnabled": {
      "type": "boolean"
    },
    "directedMulticastFromNetworkEnabled": {
      "type": "boolean"
    },
    "lteBandLockChannels": {
      "description": "LTE band lock channels options",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "simCardId": {
            "description": "SIM card ID(Primary:0, Secondary:1)",
            "type": "integer"
          },
          "type": {
            "description": "LTE chipset SKU type",
            "type": "string"
          },
          "channel4g": {
            "description": "LTE 4G channels",
            "type": "string"
          },
          "channel3g": {
            "description": "LTE 3G channels",
            "type": "string"
          }
        }
      }
    },
    "monitoringEnabled": {
      "description": "Set AP group as monitoring group.",
      "type": "boolean"
    },
    "apGroupRoguePolicy": {
      "description": "Override Rogue AP policy ID (only for monitoring group).",
      "type": "string"
    },
    "rogueScanFreq": {
      "description": "Set rogue scan frequency (only for monitoring group).",
      "type": "string",
      "enum": [
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    },
    "paloAltoFirewallProfileOverrided": {
      "type": "boolean"
    },
    "paloAltoFirewallProfileId": {
      "type": "string"
    },
    "rksGreForwardBroadcast": {
      "description": "Ruckus GRE tunnel broadcast packet forwarding",
      "type": "boolean"
    },
    "bssColoringEnable": {
      "description": "BSS coloring mechanism enabled.",
      "type": "boolean"
    },
    "radioConfig": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "radio24g": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ],
              "default": "Full"
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40
              ],
              "default": 0
            },
            "channel": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "availableChannelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "wlanGroupId": {
              "type": "string"
            },
            "wlanServiceEnabled": {
              "type": "boolean"
            },
            "protectionMode": {
              "type": "string",
              "enum": [
                "NONE",
                "CTS_ONLY",
                "RTS_CTS"
              ],
              "default": "RTS_CTS"
            },
            "backgroundScanning": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "frequencyInSec": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535,
                  "default": 20
                }
              },
              "required": [
                "frequencyInSec"
              ]
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ],
                  "default": "BackgroundScanning"
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "default": 480,
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "default": 33,
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio5g": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ],
              "default": "Full"
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ],
              "default": 0
            },
            "channel": {
              "type": "integer"
            },
            "channelIndoor": {
              "type": "integer"
            },
            "secondaryChannel": {
              "type": "integer"
            },
            "secondaryChannelIndoor": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "channelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "dfsChannelEnabled": {
              "type": "boolean"
            },
            "cbandChannelEnabled": {
              "type": "boolean"
            },
            "cbandChannelLicenseEnabled": {
              "type": "boolean"
            },
            "channel144Enabled": {
              "type": "boolean"
            },
            "channelModeEnabled": {
              "type": "boolean"
            },
            "availableChannelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "availableChannelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "wlanGroupId": {
              "type": "string"
            },
            "protectionMode": {
              "type": "string",
              "enum": [
                "NONE",
                "CTS_ONLY",
                "RTS_CTS"
              ],
              "default": "RTS_CTS"
            },
            "backgroundScanning": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "frequencyInSec": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535,
                  "default": 20
                }
              },
              "required": [
                "frequencyInSec"
              ]
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ],
                  "default": "BackgroundScanning"
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "default": 480,
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "default": 33,
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio5gUpper": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ],
              "default": "Full"
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ],
              "default": 0
            },
            "channel": {
              "type": "integer"
            },
            "channelIndoor": {
              "type": "integer"
            },
            "secondaryChannel": {
              "type": "integer"
            },
            "secondaryChannelIndoor": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "channelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "dfsChannelEnabled": {
              "type": "boolean"
            },
            "cbandChannelEnabled": {
              "type": "boolean"
            },
            "cbandChannelLicenseEnabled": {
              "type": "boolean"
            },
            "channel144Enabled": {
              "type": "boolean"
            },
            "channelModeEnabled": {
              "type": "boolean"
            },
            "availableChannelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "availableChannelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "wlanGroupId": {
              "type": "string"
            },
            "protectionMode": {
              "type": "string",
              "enum": [
                "NONE",
                "CTS_ONLY",
                "RTS_CTS"
              ],
              "default": "RTS_CTS"
            },
            "backgroundScanning": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "frequencyInSec": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535,
                  "default": 20
                }
              },
              "required": [
                "frequencyInSec"
              ]
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ],
                  "default": "BackgroundScanning"
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "default": 480,
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "default": 33,
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio5gLower": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ],
              "default": "Full"
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ],
              "default": 0
            },
            "channel": {
              "type": "integer"
            },
            "channelIndoor": {
              "type": "integer"
            },
            "secondaryChannel": {
              "type": "integer"
            },
            "secondaryChannelIndoor": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "channelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "dfsChannelEnabled": {
              "type": "boolean"
            },
            "cbandChannelEnabled": {
              "type": "boolean"
            },
            "cbandChannelLicenseEnabled": {
              "type": "boolean"
            },
            "channel144Enabled": {
              "type": "boolean"
            },
            "channelModeEnabled": {
              "type": "boolean"
            },
            "availableChannelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "availableChannelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "wlanGroupId": {
              "type": "string"
            },
            "protectionMode": {
              "type": "string",
              "enum": [
                "NONE",
                "CTS_ONLY",
                "RTS_CTS"
              ],
              "default": "RTS_CTS"
            },
            "backgroundScanning": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "frequencyInSec": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535,
                  "default": 20
                }
              },
              "required": [
                "frequencyInSec"
              ]
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ],
                  "default": "BackgroundScanning"
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "default": 480,
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "default": 33,
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio6g": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ],
              "default": "Full"
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ],
              "default": 0
            },
            "channel": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "lowPowerIndoorModeEnabled": {
              "type": "boolean"
            },
            "availableChannelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "wlanGroupId": {
              "type": "string"
            },
            "wlanServiceEnabled": {
              "type": "boolean"
            },
            "protectionMode": {
              "type": "string",
              "enum": [
                "NONE",
                "CTS_ONLY",
                "RTS_CTS"
              ],
              "default": "RTS_CTS"
            },
            "backgroundScanning": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "frequencyInSec": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535,
                  "default": 20
                }
              },
              "required": [
                "frequencyInSec"
              ]
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ],
                  "default": "BackgroundScanning"
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "default": 480,
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "default": 33,
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            },
            "bssMinRate": {
              "description": "6G BSS minimum rate (mbps)",
              "type": "string",
              "enum": [
                "HE-MCS0",
                "HE-MCS1",
                "HE-MCS2",
                "HE-MCS3"
              ]
            },
            "mgmtTxRate": {
              "description": "6G management TX rate (mbps)",
              "type": "string",
              "enum": [
                "6 mbps",
                "9 mbps",
                "12 mbps",
                "18 mbps",
                "24 mbps",
                "36 mbps",
                "48 mbps",
                "54 mbps"
              ]
            },
            "multicastUplinkRateLimit": {
              "description": "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
              "type": "integer",
              "minimum": 0,
              "maximum": 100
            },
            "multicastDownlinkRateLimit": {
              "description": "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
              "type": "integer",
              "minimum": 0,
              "maximum": 100
            }
          }
        },
        "dual5gEnabled": {
          "type": "boolean"
        }
      }
    }
  },
  "required": [
    "name"
  ]
}

Retrieve AP Model

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

Use this API command to retrieve AP model specific configuration override zone that belong to an AP group, NULL means the override setting is not checked inside an AP group.

Response  200
HideShow
Body
{
  "ledStatusEnabled": true,
  "lacp": {
    "keepApSetting": false,
    "enabled": true,
    "bondPortProfileId": "ed395d1c-45a7-4d85-994f-244c38c83f2c"
  },
  "lldp": {
    "enabled": true,
    "advertiseIntervalInSec": 30,
    "holdTimeInSec": 120,
    "managementIPTLVEnabled": false
  },
  "cellularSettings": {
    "mobileAPName": "internet",
    "mobileAPName2": "internet",
    "simCardUsage": 0,
    "select3g4g": 0,
    "select3g4g2": 0,
    "dataRoaming": 1,
    "dataRoaming2": 1,
    "wanConnection": 0,
    "wanRecoveryTimer": 60
  },
  "ledMode": null,
  "internalHeaterEnabled": null,
  "poeOutPortEnabled": null,
  "usbPowerEnable": true,
  "poeModeSetting": "Auto",
  "poeTxChain": 2,
  "radioBand": null,
  "externalAntenna24": null,
  "externalAntenna50": null,
  "lanPorts": [
    {
      "portName": "LAN1",
      "enabled": false,
      "ethPortProfile": null
    },
    {
      "portName": "LAN2",
      "enabled": true,
      "ethPortProfile": {
        "id": "0",
        "name": "Default Trunk Port"
      }
    },
    {
      "portName": "LAN3",
      "enabled": true,
      "ethPortProfile": {
        "id": "1",
        "name": "Default Access Port"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ledStatusEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "lldp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean",
          "default": true
        },
        "advertiseIntervalInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 300
        },
        "holdTimeInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 60,
          "maximum": 1200
        },
        "managementIPTLVEnabled": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lacp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "keepApSetting": {
          "type": "boolean"
        },
        "enabled": {
          "type": "boolean"
        },
        "bondPortProfileId": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "cellularSettings": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mobileAPName": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
        },
        "mobileAPName2": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
        },
        "simCardUsage": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 2
        },
        "select3g4g": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2
        },
        "select3g4g2": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2
        },
        "dataRoaming": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 1
        },
        "dataRoaming2": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 1
        },
        "wanConnection": {
          "type": "integer",
          "minimum": 0,
          "maximum": 3
        },
        "wanRecoveryTimer": {
          "type": "integer",
          "minimum": 10,
          "maximum": 300
        }
      },
      "required": [
        "select3g4g",
        "select3g4g2",
        "wanConnection",
        "wanRecoveryTimer"
      ]
    },
    "ledMode": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        null,
        "CableModem",
        "AccessPoint",
        "CableModem_AccessPoint",
        "CableModem_AccessPoint_DEFAULT",
        "ActiveSurgeProtector",
        "ActiveSurgeProtector_ModemOnline_DEFAULT",
        "Off"
      ]
    },
    "internalHeaterEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeOutPortEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "usbPowerEnable": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeModeSetting": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "Auto",
        "_802_3af",
        "_802_3at",
        "_802_3atPlus",
        "_802_3bt_Class_5",
        "_802_3bt_Class_6",
        "_802_3bt_Class_7",
        "_802_3bt_Class_8",
        null
      ]
    },
    "poeTxChain": {
      "description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
      "default": 2,
      "type": [
        "integer",
        "null"
      ]
    },
    "radioBand": {
      "description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
      "type": [
        "string",
        "null"
      ],
      "enum": [
        null,
        "2.4GHz",
        "5GHz"
      ]
    },
    "externalAntenna24": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "dbi": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 90
        },
        "chainMask": {
          "type": [
            "string",
            "null"
          ],
          "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": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            null,
            "Two",
            "Three"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lanPorts": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "portName": {
            "type": "string",
            "enum": [
              "LAN1",
              "LAN2",
              "LAN3",
              "LAN4",
              "LAN5"
            ]
          },
          "enabled": {
            "type": "boolean"
          },
          "ethPortProfile": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "portName",
          "enabled"
        ]
      }
    }
  }
}

Add Member

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

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

Response  201

Create

POST/v11_1/rkszones/{zoneId}/apgroups

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

Request
HideShow
Body
{
  "name": "apGroupName",
  "description": "apGroupDescription",
  "location": "Location",
  "locationAdditionalInfo": "Location_Additional_Info",
  "latitude": 37.411,
  "longitude": -122.0196,
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 65
  },
  "radioConfig": {
    "radio24g": {
      "txPower": "-5dB",
      "channelWidth": 40,
      "channel": 5,
      "channelRange": [
        1,
        2,
        3,
        4,
        5,
        6
      ],
      "wlanGroupId": "3b779e31-4469-11e8-823e-3e3d08a406ec",
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      },
      "protectionMode": "CTS_ONLY"
    },
    "radio5g": {
      "txPower": "-5dB",
      "channelWidth": 20,
      "channel": 157,
      "channelIndoor": 36,
      "channelRange": [
        157,
        161
      ],
      "channelRangeIndoor": [
        36,
        40,
        44,
        48,
        157,
        161
      ],
      "wlanGroupId": "4550acd1-4469-11e8-823e-3e3d08a406ec",
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      }
    }
  },
  "locationBasedService": {
    "id": "7bebe311-4471-11e8-823e-3e3d08a406ec",
    "name": "lbs01",
    "enabled": true
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 75,
    "minClientCount": 10,
    "minClientThroughputMbps": 0,
    "enabled": true
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 75,
    "minClientCount": 20,
    "minClientThroughputMbps": 0,
    "enabled": true
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "rogueApReportThreshold": 30,
  "rogueApAggressivenessMode": 1,
  "rogueApJammingThreshold": 30,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": true,
  "monitoringEnabled": false,
  "rogueScanFreq": "LOW",
  "paloAltoFirewallProfileOverrided": true,
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "apMgmtVlan": {
    "id": 123,
    "mode": "USER_DEFINED"
  },
  "venueProfile": {
    "id": "631d8150-4484-11e8-8b35-3e3d08a406ec",
    "name": "venueProfile"
  },
  "channelEvaluationInterval": 777,
  "bssColoringEnable": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the AP group",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the AP group",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "location": {
      "description": "Location of the AP group.",
      "type": "string"
    },
    "locationAdditionalInfo": {
      "description": "Location additional info of the AP group.",
      "type": "string"
    },
    "altitude": {
      "description": "GPS Altitude",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "altitudeUnit": {
          "description": "altitude unit",
          "type": "string",
          "enum": [
            "meters",
            "floor"
          ],
          "default": "meters"
        },
        "altitudeValue": {
          "description": "altitude value",
          "type": "integer"
        }
      }
    },
    "latitude": {
      "description": "Latitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "longitude": {
      "description": "Longitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "locationBasedService": {
      "description": "Location based service configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "clientAdmissionControl24": {
      "description": "AP client admission control of 2.4GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "default": 75,
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "default": 10,
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "default": 0,
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "clientAdmissionControl50": {
      "description": "AP client admission control of 5GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "default": 75,
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "default": 10,
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "default": 0,
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "snmpAgent": {
      "description": "SNMP Agent",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "apSnmpEnabled": {
          "description": "Enable AP SNMP",
          "type": "boolean"
        },
        "snmpConfigType": {
          "description": "The config type of SNMP",
          "type": "string",
          "enum": [
            "CUSTOM",
            "AP_SNMP_AGENT_PROFILE"
          ],
          "default": "CUSTOM"
        },
        "apSnmpAgentProfileId": {
          "type": "string"
        },
        "snmpV2Agent": {
          "description": "Community List of the SNMP V2 Agent.",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "communityName": {
                "description": "name of the SNMP Community.",
                "type": "string"
              },
              "readEnabled": {
                "description": "read privilege of the SNMP Coummunity",
                "type": "boolean"
              },
              "writeEnabled": {
                "description": "write privilege of the SNMP Coummunity",
                "type": "boolean"
              },
              "notificationEnabled": {
                "description": "notification privilege of the SNMP Coummunity",
                "type": "boolean"
              },
              "notificationType": {
                "description": "type of the notification privilege",
                "type": "string",
                "enum": [
                  "TRAP",
                  "INFORM"
                ]
              },
              "notificationTarget": {
                "description": "Trap List of the SNMP Coummunity",
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "address": {
                      "description": "address of the SNMP Trap",
                      "type": "string"
                    },
                    "port": {
                      "description": "port number of the SNMP Trap",
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 65535
                    }
                  },
                  "required": [
                    "address",
                    "port"
                  ]
                }
              }
            },
            "required": [
              "communityName",
              "readEnabled",
              "writeEnabled",
              "notificationEnabled"
            ]
          }
        },
        "snmpV3Agent": {
          "description": "User List of the SNMP V3 Agent.",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "userName": {
                "description": "name of the SNMP User.",
                "type": "string"
              },
              "authProtocol": {
                "description": "authProtocol of the SNMP User.",
                "type": "string",
                "enum": [
                  "NONE",
                  "MD5",
                  "SHA"
                ]
              },
              "authPassword": {
                "description": "authPassword of the SNMP User.",
                "type": "string",
                "minLength": 8
              },
              "privProtocol": {
                "description": "privProtocol of the SNMP User.",
                "type": "string",
                "enum": [
                  "NONE",
                  "DES",
                  "AES"
                ]
              },
              "privPassword": {
                "description": "privPassword of the SNMP User.",
                "type": "string",
                "minLength": 8
              },
              "readEnabled": {
                "description": "read privilege of the SNMP User",
                "type": "boolean"
              },
              "writeEnabled": {
                "description": "write privilege of the SNMP User",
                "type": "boolean"
              },
              "notificationEnabled": {
                "description": "notification privilege of the SNMP User",
                "type": "boolean"
              },
              "notificationType": {
                "description": "type of the notification privilege",
                "type": "string",
                "enum": [
                  "TRAP",
                  "INFORM"
                ]
              },
              "notificationTarget": {
                "description": "Trap List of the SNMP User",
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "address": {
                      "description": "address of the SNMP Trap",
                      "type": "string"
                    },
                    "port": {
                      "description": "port number of the SNMP Trap",
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 65535
                    }
                  },
                  "required": [
                    "address",
                    "port"
                  ]
                }
              }
            },
            "required": [
              "userName",
              "readEnabled",
              "writeEnabled",
              "notificationEnabled"
            ]
          }
        }
      }
    },
    "venueProfile": {
      "description": "Venue profile configuration of the AP group.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "channelEvaluationInterval": {
      "description": "channel evaluation Interval of the ap group",
      "type": "integer",
      "default": 600,
      "minimum": 60,
      "maximum": 3600
    },
    "apMgmtVlan": {
      "description": "ap Management Vlan of the apgroup",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mode": {
          "description": "Vlan Mode of the zone",
          "type": "string",
          "enum": [
            "KEEP",
            "USER_DEFINED"
          ],
          "default": "KEEP"
        },
        "id": {
          "description": "Vlan id of the zone",
          "type": "integer",
          "default": "1"
        }
      }
    },
    "recoverySsid": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "recoverySsidEnabled": {
          "description": "recovery ssid enable/disable",
          "type": "boolean"
        }
      }
    },
    "rogueApReportThreshold": {
      "description": "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
      "type": "integer"
    },
    "rogueApAggressivenessMode": {
      "description": "Adjust the frequency interval to de-authenticate rogue APs.",
      "type": "integer"
    },
    "rogueApJammingThreshold": {
      "type": "integer"
    },
    "directedMulticastFromWiredClientEnabled": {
      "description": "Directed multicast from wired client to network.",
      "type": "boolean"
    },
    "directedMulticastFromWirelessClientEnabled": {
      "description": "Directed multicast from wireless client to network.",
      "type": "boolean"
    },
    "directedMulticastFromNetworkEnabled": {
      "description": "Directed multicast from network to wired / wireless client.",
      "type": "boolean"
    },
    "lteBandLockChannels": {
      "description": "LTE band lock channels options",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "simCardId": {
            "description": "SIM card ID(Primary:0, Secondary:1)",
            "type": "integer"
          },
          "type": {
            "description": "LTE chipset SKU type",
            "type": "string"
          },
          "channel4g": {
            "description": "LTE 4G channels",
            "type": "string"
          },
          "channel3g": {
            "description": "LTE 3G channels",
            "type": "string"
          }
        }
      }
    },
    "monitoringEnabled": {
      "description": "Set AP group as monitoring group.",
      "type": "boolean"
    },
    "apGroupRoguePolicy": {
      "description": "Override Rogue AP policy ID (only for monitoring group).",
      "type": "string"
    },
    "rogueScanFreq": {
      "description": "Set rogue scan frequency (only for monitoring group).",
      "type": "string",
      "enum": [
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    },
    "paloAltoFirewallProfileOverrided": {
      "type": "boolean"
    },
    "paloAltoFirewallProfileId": {
      "type": "string"
    },
    "rksGreForwardBroadcast": {
      "description": "Ruckus GRE tunnel broadcast packet forwarding",
      "type": "boolean"
    },
    "bssColoringEnable": {
      "description": "Turn on/off BSS coloring mechanism.",
      "type": "boolean"
    },
    "radioConfig": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "radio24g": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ],
              "default": "Full"
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40
              ],
              "default": 0
            },
            "channel": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "minItems": 1
            },
            "wlanGroupId": {
              "type": "string"
            },
            "protectionMode": {
              "type": "string",
              "enum": [
                "NONE",
                "CTS_ONLY",
                "RTS_CTS"
              ],
              "default": "RTS_CTS"
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ],
                  "default": "BackgroundScanning"
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "default": 480,
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "default": 33,
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio5g": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ],
              "default": "Full"
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ],
              "default": 0
            },
            "channel": {
              "type": "integer"
            },
            "channelIndoor": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "minItems": 1
            },
            "channelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "secondaryChannel": {
              "type": "integer"
            },
            "secondaryChannelIndoor": {
              "type": "integer"
            },
            "wlanGroupId": {
              "type": "string"
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ],
                  "default": "BackgroundScanning"
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "default": 480,
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "default": 33,
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio5gLower": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ],
              "default": "Full"
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ],
              "default": 0
            },
            "channel": {
              "type": "integer"
            },
            "channelIndoor": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "minItems": 1
            },
            "channelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "secondaryChannel": {
              "type": "integer"
            },
            "secondaryChannelIndoor": {
              "type": "integer"
            },
            "wlanGroupId": {
              "type": "string"
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ],
                  "default": "BackgroundScanning"
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "default": 480,
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "default": 33,
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio5gUpper": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ],
              "default": "Full"
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ],
              "default": 0
            },
            "channel": {
              "type": "integer"
            },
            "channelIndoor": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "minItems": 1
            },
            "channelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "secondaryChannel": {
              "type": "integer"
            },
            "secondaryChannelIndoor": {
              "type": "integer"
            },
            "wlanGroupId": {
              "type": "string"
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ],
                  "default": "BackgroundScanning"
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "default": 480,
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "default": 33,
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio6g": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ],
              "default": "Full"
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ],
              "default": 0
            },
            "channel": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "minItems": 1
            },
            "wlanGroupId": {
              "type": "string"
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ],
                  "default": "BackgroundScanning"
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "default": 480,
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "default": 33,
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            },
            "bssMinRate": {
              "description": "6G BSS minimum rate (mbps)",
              "type": "string",
              "enum": [
                "HE-MCS0",
                "HE-MCS1",
                "HE-MCS2",
                "HE-MCS3"
              ]
            },
            "mgmtTxRate": {
              "description": "6G management TX rate (mbps)",
              "type": "string",
              "enum": [
                "6 mbps",
                "9 mbps",
                "12 mbps",
                "18 mbps",
                "24 mbps",
                "36 mbps",
                "48 mbps",
                "54 mbps"
              ]
            },
            "multicastUplinkRateLimit": {
              "description": "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
              "type": "integer",
              "minimum": 0,
              "maximum": 100
            },
            "multicastDownlinkRateLimit": {
              "description": "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
              "type": "integer",
              "minimum": 0,
              "maximum": 100
            }
          }
        },
        "dual5gEnabled": {
          "type": "boolean"
        }
      }
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": "apGroupUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Add Member List

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

Add multiple members to an AP group.

Request
HideShow
Body
{
  "memberList": [
    {
      "apMac": "00:22:11:0C:BD:13"
    },
    {
      "apMac": "10:11:22:0C:0D:15"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "memberList": {
      "description": "List of apMac",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "apMac": {
            "description": "MAC address of member AP",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "apSerial": {
            "description": "Serial number of member AP",
            "type": "string"
          }
        }
      }
    }
  }
}
Response  201

Modify Entire

PUT/v11_1/rkszones/{zoneId}/apgroups/{id}

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

Request
HideShow
Body
{
  "name": "apGroupNameModified",
  "description": "apGroupDescriptionModified",
  "location": "test-ap1_modify",
  "locationAdditionalInfo": "add",
  "latitude": 34,
  "longitude": 45,
  "radioConfig": {
    "radio24g": {
      "txPower": "-5dB",
      "channelWidth": 40,
      "channel": 5,
      "channelRange": [
        1,
        2,
        3,
        4,
        5,
        6
      ],
      "wlanGroupId": "3b779e31-4469-11e8-823e-3e3d08a406ec",
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      },
      "protectionMode": "CTS_ONLY"
    },
    "radio5g": {
      "txPower": "-5dB",
      "channelWidth": 20,
      "channel": 157,
      "channelIndoor": 36,
      "channelRange": [
        157,
        161
      ],
      "channelRangeIndoor": [
        36,
        40,
        44,
        48,
        157,
        161
      ],
      "wlanGroupId": "4550acd1-4469-11e8-823e-3e3d08a406ec",
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      }
    }
  },
  "locationBasedService": {
    "id": "lbsServiceId",
    "name": "lbsServiceName"
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "venueProfile": {
    "id": "venueProfileId",
    "name": "venueProfileName"
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "rogueApReportThreshold": 30,
  "rogueApAggressivenessMode": 1,
  "rogueApJammingThreshold": 30,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "type": "EC25E",
      "channel4g": "B1,B3,B5",
      "channel3g": "B5"
    },
    {
      "simCardId": 1,
      "type": "EC25E",
      "channel4g": "",
      "channel3g": ""
    }
  ],
  "monitoringEnabled": false,
  "rogueScanFreq": "LOW",
  "paloAltoFirewallProfileOverrided": true,
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "bssColoringEnable": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the AP group",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the AP group",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "location": {
      "description": "Location of the AP group.",
      "type": "string"
    },
    "locationAdditionalInfo": {
      "description": "Location additional info of the AP group.",
      "type": "string"
    },
    "altitude": {
      "description": "GPS Altitude",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "altitudeUnit": {
          "description": "altitude unit",
          "type": "string",
          "enum": [
            "meters",
            "floor"
          ]
        },
        "altitudeValue": {
          "description": "altitude value",
          "type": "integer"
        }
      }
    },
    "latitude": {
      "description": "Latitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "longitude": {
      "description": "Longitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "locationBasedService": {
      "description": "Location based service configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "clientAdmissionControl24": {
      "description": "AP client admission control of 2.4GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "clientAdmissionControl50": {
      "description": "AP client admission control of 5GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "snmpAgent": {
      "description": "SNMP Agent",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "apSnmpEnabled": {
          "description": "Enable AP SNMP",
          "type": "boolean"
        },
        "snmpConfigType": {
          "description": "The config type of SNMP",
          "type": "string",
          "enum": [
            "CUSTOM",
            "AP_SNMP_AGENT_PROFILE"
          ]
        },
        "apSnmpAgentProfileId": {
          "type": "string"
        },
        "snmpV2Agent": {
          "description": "Community List of the SNMP V2 Agent.",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "communityName": {
                "description": "name of the SNMP Community.",
                "type": "string"
              },
              "readEnabled": {
                "description": "read privilege of the SNMP Coummunity",
                "type": "boolean"
              },
              "writeEnabled": {
                "description": "write privilege of the SNMP Coummunity",
                "type": "boolean"
              },
              "notificationEnabled": {
                "description": "notification privilege of the SNMP Coummunity",
                "type": "boolean"
              },
              "notificationType": {
                "description": "type of the notification privilege",
                "type": "string",
                "enum": [
                  "TRAP",
                  "INFORM"
                ]
              },
              "notificationTarget": {
                "description": "Trap List of the SNMP Coummunity",
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "address": {
                      "description": "address of the SNMP Trap",
                      "type": "string"
                    },
                    "port": {
                      "description": "port number of the SNMP Trap",
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 65535
                    }
                  },
                  "required": [
                    "address",
                    "port"
                  ]
                }
              }
            },
            "required": [
              "communityName",
              "readEnabled",
              "writeEnabled",
              "notificationEnabled"
            ]
          }
        },
        "snmpV3Agent": {
          "description": "User List of the SNMP V3 Agent.",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "userName": {
                "description": "name of the SNMP User.",
                "type": "string"
              },
              "authProtocol": {
                "description": "authProtocol of the SNMP User.",
                "type": "string",
                "enum": [
                  "NONE",
                  "MD5",
                  "SHA"
                ]
              },
              "authPassword": {
                "description": "authPassword of the SNMP User.",
                "type": "string",
                "minLength": 8
              },
              "privProtocol": {
                "description": "privProtocol of the SNMP User.",
                "type": "string",
                "enum": [
                  "NONE",
                  "DES",
                  "AES"
                ]
              },
              "privPassword": {
                "description": "privPassword of the SNMP User.",
                "type": "string",
                "minLength": 8
              },
              "readEnabled": {
                "description": "read privilege of the SNMP User",
                "type": "boolean"
              },
              "writeEnabled": {
                "description": "write privilege of the SNMP User",
                "type": "boolean"
              },
              "notificationEnabled": {
                "description": "notification privilege of the SNMP User",
                "type": "boolean"
              },
              "notificationType": {
                "description": "type of the notification privilege",
                "type": "string",
                "enum": [
                  "TRAP",
                  "INFORM"
                ]
              },
              "notificationTarget": {
                "description": "Trap List of the SNMP User",
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "address": {
                      "description": "address of the SNMP Trap",
                      "type": "string"
                    },
                    "port": {
                      "description": "port number of the SNMP Trap",
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 65535
                    }
                  },
                  "required": [
                    "address",
                    "port"
                  ]
                }
              }
            },
            "required": [
              "userName",
              "readEnabled",
              "writeEnabled",
              "notificationEnabled"
            ]
          }
        }
      }
    },
    "venueProfile": {
      "description": "Venue profile configuration of the AP group.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "channelEvaluationInterval": {
      "description": "channel evaluation Interval of the ap group",
      "type": "integer",
      "minimum": 60,
      "maximum": 3600
    },
    "apMgmtVlan": {
      "description": "ap Management Vlan of the apgroup",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mode": {
          "description": "Vlan Mode of the zone",
          "type": "string",
          "enum": [
            "KEEP",
            "USER_DEFINED"
          ]
        },
        "id": {
          "description": "Vlan id of the zone",
          "type": "integer"
        }
      }
    },
    "recoverySsid": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "recoverySsidEnabled": {
          "description": "recovery ssid enable/disable",
          "type": "boolean"
        }
      }
    },
    "rogueApReportThreshold": {
      "description": "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
      "type": "integer"
    },
    "rogueApAggressivenessMode": {
      "description": "Adjust the frequency interval to de-authenticate rogue APs.",
      "type": "integer"
    },
    "rogueApJammingThreshold": {
      "type": "integer"
    },
    "directedMulticastFromWiredClientEnabled": {
      "description": "Directed multicast from wired client to network.",
      "type": "boolean"
    },
    "directedMulticastFromWirelessClientEnabled": {
      "description": "Directed multicast from wireless client to network.",
      "type": "boolean"
    },
    "directedMulticastFromNetworkEnabled": {
      "description": "Directed multicast from network to wired / wireless client.",
      "type": "boolean"
    },
    "lteBandLockChannels": {
      "description": "LTE band lock channels options",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "simCardId": {
            "description": "SIM card ID(Primary:0, Secondary:1)",
            "type": "integer"
          },
          "type": {
            "description": "LTE chipset SKU type",
            "type": "string"
          },
          "channel4g": {
            "description": "LTE 4G channels",
            "type": "string"
          },
          "channel3g": {
            "description": "LTE 3G channels",
            "type": "string"
          }
        }
      }
    },
    "monitoringEnabled": {
      "description": "Set AP group as monitoring group.",
      "type": "boolean"
    },
    "apGroupRoguePolicy": {
      "description": "Override Rogue AP policy ID (only for monitoring group).",
      "type": "string"
    },
    "rogueScanFreq": {
      "description": "Set rogue scan frequency (only for monitoring group).",
      "type": "string",
      "enum": [
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    },
    "paloAltoFirewallProfileOverrided": {
      "type": "boolean"
    },
    "paloAltoFirewallProfileId": {
      "type": "string"
    },
    "rksGreForwardBroadcast": {
      "description": "Ruckus GRE tunnel broadcast packet forwarding",
      "type": "boolean"
    },
    "bssColoringEnable": {
      "description": "Turn on/off BSS coloring mechanism.",
      "type": "boolean"
    },
    "radioConfig": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "radio24g": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ]
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40
              ]
            },
            "channel": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "minItems": 1
            },
            "wlanGroupId": {
              "type": "string"
            },
            "protectionMode": {
              "type": "string",
              "enum": [
                "NONE",
                "CTS_ONLY",
                "RTS_CTS"
              ]
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ]
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio5g": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ]
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ]
            },
            "channel": {
              "type": "integer"
            },
            "channelIndoor": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "minItems": 1
            },
            "channelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "secondaryChannel": {
              "type": "integer"
            },
            "secondaryChannelIndoor": {
              "type": "integer"
            },
            "wlanGroupId": {
              "type": "string"
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ]
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio5gLower": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ]
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ]
            },
            "channel": {
              "type": "integer"
            },
            "channelIndoor": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "minItems": 1
            },
            "channelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "secondaryChannel": {
              "type": "integer"
            },
            "secondaryChannelIndoor": {
              "type": "integer"
            },
            "wlanGroupId": {
              "type": "string"
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ]
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio5gUpper": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ]
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ]
            },
            "channel": {
              "type": "integer"
            },
            "channelIndoor": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "minItems": 1
            },
            "channelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "secondaryChannel": {
              "type": "integer"
            },
            "secondaryChannelIndoor": {
              "type": "integer"
            },
            "wlanGroupId": {
              "type": "string"
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ]
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio6g": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ]
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ]
            },
            "channel": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "minItems": 1
            },
            "wlanGroupId": {
              "type": "string"
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ]
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            },
            "bssMinRate": {
              "description": "6G BSS minimum rate (mbps)",
              "type": "string",
              "enum": [
                "HE-MCS0",
                "HE-MCS1",
                "HE-MCS2",
                "HE-MCS3"
              ]
            },
            "mgmtTxRate": {
              "description": "6G management TX rate (mbps)",
              "type": "string",
              "enum": [
                "6 mbps",
                "9 mbps",
                "12 mbps",
                "18 mbps",
                "24 mbps",
                "36 mbps",
                "48 mbps",
                "54 mbps"
              ]
            },
            "multicastUplinkRateLimit": {
              "description": "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
              "type": "integer",
              "minimum": 0,
              "maximum": 100
            },
            "multicastDownlinkRateLimit": {
              "description": "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
              "type": "integer",
              "minimum": 0,
              "maximum": 100
            }
          }
        },
        "dual5gEnabled": {
          "type": "boolean"
        }
      }
    }
  }
}
Response  204

Override AP Model

PUT/v11_1/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}

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

Request
HideShow
Body
{
  "ledStatusEnabled": true,
  "lacp": {
    "keepApSetting": false,
    "enabled": true,
    "bondPortProfileId": "ed395d1c-45a7-4d85-994f-244c38c83f2c"
  },
  "lldp": {
    "enabled": true,
    "advertiseIntervalInSec": 30,
    "holdTimeInSec": 120,
    "managementIPTLVEnabled": false
  },
  "cellularSettings": {
    "mobileAPName": "internet",
    "mobileAPName2": "internet",
    "simCardUsage": 0,
    "select3g4g": 0,
    "select3g4g2": 0,
    "dataRoaming": 1,
    "dataRoaming2": 1,
    "wanConnection": 0,
    "wanRecoveryTimer": 60
  },
  "ledMode": null,
  "internalHeaterEnabled": null,
  "poeOutPortEnabled": null,
  "usbPowerEnable": true,
  "poeModeSetting": "Auto",
  "poeTxChain": 2,
  "radioBand": null,
  "externalAntenna24": null,
  "externalAntenna50": null,
  "lanPorts": [
    {
      "portName": "LAN1",
      "enabled": false,
      "ethPortProfile": null
    },
    {
      "portName": "LAN2",
      "enabled": true,
      "ethPortProfile": {
        "id": "0",
        "name": "Default Trunk Port"
      }
    },
    {
      "portName": "LAN3",
      "enabled": true,
      "ethPortProfile": {
        "id": "1",
        "name": "Default Access Port"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ledStatusEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "lldp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "advertiseIntervalInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 300
        },
        "holdTimeInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 60,
          "maximum": 1200
        },
        "managementIPTLVEnabled": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lacp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "keepApSetting": {
          "type": "boolean"
        },
        "enabled": {
          "type": "boolean"
        },
        "bondPortProfileId": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "cellularSettings": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mobileAPName": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
        },
        "mobileAPName2": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
        },
        "simCardUsage": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 2
        },
        "select3g4g": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2
        },
        "select3g4g2": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2
        },
        "dataRoaming": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 1
        },
        "dataRoaming2": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 1
        },
        "wanConnection": {
          "type": "integer",
          "minimum": 0,
          "maximum": 3
        },
        "wanRecoveryTimer": {
          "type": "integer",
          "minimum": 10,
          "maximum": 300
        }
      },
      "required": [
        "select3g4g",
        "select3g4g2",
        "wanConnection",
        "wanRecoveryTimer"
      ]
    },
    "ledMode": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        null,
        "CableModem",
        "AccessPoint",
        "CableModem_AccessPoint",
        "CableModem_AccessPoint_DEFAULT",
        "ActiveSurgeProtector",
        "ActiveSurgeProtector_ModemOnline_DEFAULT",
        "Off"
      ]
    },
    "internalHeaterEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeOutPortEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "usbPowerEnable": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeModeSetting": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "Auto",
        "_802_3af",
        "_802_3at",
        "_802_3atPlus",
        "_802_3bt_Class_5",
        "_802_3bt_Class_6",
        "_802_3bt_Class_7",
        "_802_3bt_Class_8",
        null
      ]
    },
    "poeTxChain": {
      "description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
      "type": [
        "integer",
        "null"
      ]
    },
    "radioBand": {
      "description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
      "type": [
        "string",
        "null"
      ],
      "enum": [
        null,
        "2.4GHz",
        "5GHz"
      ]
    },
    "externalAntenna24": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "dbi": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 90
        },
        "chainMask": {
          "type": [
            "string",
            "null"
          ],
          "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": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            null,
            "Two",
            "Three"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lanPorts": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "portName": {
            "type": "string",
            "enum": [
              "LAN1",
              "LAN2",
              "LAN3",
              "LAN4",
              "LAN5"
            ]
          },
          "enabled": {
            "type": "boolean"
          },
          "ethPortProfile": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "portName",
          "enabled"
        ]
      }
    }
  }
}
Response  204

Modify

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

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

Request
HideShow
Body
{
  "name": "apGroupNameModified",
  "description": "apGroupDescriptionModified",
  "location": "test-ap1_modify",
  "locationAdditionalInfo": "add",
  "latitude": 34,
  "longitude": 45,
  "radioConfig": {
    "radio24g": {
      "txPower": "-5dB",
      "channelWidth": 40,
      "channel": 5,
      "channelRange": [
        1,
        2,
        3,
        4,
        5,
        6
      ],
      "wlanGroupId": "3b779e31-4469-11e8-823e-3e3d08a406ec",
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      },
      "protectionMode": "CTS_ONLY"
    },
    "radio5g": {
      "txPower": "-5dB",
      "channelWidth": 20,
      "channel": 157,
      "channelIndoor": 36,
      "channelRange": [
        157,
        161
      ],
      "channelRangeIndoor": [
        36,
        40,
        44,
        48,
        157,
        161
      ],
      "wlanGroupId": "4550acd1-4469-11e8-823e-3e3d08a406ec",
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      }
    }
  },
  "locationBasedService": {
    "id": "lbsServiceId",
    "name": "lbsServiceName"
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "venueProfile": {
    "id": "venueProfileId",
    "name": "venueProfileName"
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "rogueApReportThreshold": 30,
  "rogueApAggressivenessMode": 1,
  "rogueApJammingThreshold": 30,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "type": "EC25E",
      "channel4g": "B1,B3,B5",
      "channel3g": "B5"
    },
    {
      "simCardId": 1,
      "type": "EC25E",
      "channel4g": "",
      "channel3g": ""
    }
  ],
  "monitoringEnabled": false,
  "rogueScanFreq": "LOW",
  "paloAltoFirewallProfileOverrided": true,
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "bssColoringEnable": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the AP group",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the AP group",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "location": {
      "description": "Location of the AP group.",
      "type": "string"
    },
    "locationAdditionalInfo": {
      "description": "Location additional info of the AP group.",
      "type": "string"
    },
    "altitude": {
      "description": "GPS Altitude",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "altitudeUnit": {
          "description": "altitude unit",
          "type": "string",
          "enum": [
            "meters",
            "floor"
          ]
        },
        "altitudeValue": {
          "description": "altitude value",
          "type": "integer"
        }
      }
    },
    "latitude": {
      "description": "Latitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "longitude": {
      "description": "Longitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "locationBasedService": {
      "description": "Location based service configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "clientAdmissionControl24": {
      "description": "AP client admission control of 2.4GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "clientAdmissionControl50": {
      "description": "AP client admission control of 5GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "snmpAgent": {
      "description": "SNMP Agent",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "apSnmpEnabled": {
          "description": "Enable AP SNMP",
          "type": "boolean"
        },
        "snmpConfigType": {
          "description": "The config type of SNMP",
          "type": "string",
          "enum": [
            "CUSTOM",
            "AP_SNMP_AGENT_PROFILE"
          ]
        },
        "apSnmpAgentProfileId": {
          "type": "string"
        },
        "snmpV2Agent": {
          "description": "Community List of the SNMP V2 Agent.",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "communityName": {
                "description": "name of the SNMP Community.",
                "type": "string"
              },
              "readEnabled": {
                "description": "read privilege of the SNMP Coummunity",
                "type": "boolean"
              },
              "writeEnabled": {
                "description": "write privilege of the SNMP Coummunity",
                "type": "boolean"
              },
              "notificationEnabled": {
                "description": "notification privilege of the SNMP Coummunity",
                "type": "boolean"
              },
              "notificationType": {
                "description": "type of the notification privilege",
                "type": "string",
                "enum": [
                  "TRAP",
                  "INFORM"
                ]
              },
              "notificationTarget": {
                "description": "Trap List of the SNMP Coummunity",
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "address": {
                      "description": "address of the SNMP Trap",
                      "type": "string"
                    },
                    "port": {
                      "description": "port number of the SNMP Trap",
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 65535
                    }
                  },
                  "required": [
                    "address",
                    "port"
                  ]
                }
              }
            },
            "required": [
              "communityName",
              "readEnabled",
              "writeEnabled",
              "notificationEnabled"
            ]
          }
        },
        "snmpV3Agent": {
          "description": "User List of the SNMP V3 Agent.",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "userName": {
                "description": "name of the SNMP User.",
                "type": "string"
              },
              "authProtocol": {
                "description": "authProtocol of the SNMP User.",
                "type": "string",
                "enum": [
                  "NONE",
                  "MD5",
                  "SHA"
                ]
              },
              "authPassword": {
                "description": "authPassword of the SNMP User.",
                "type": "string",
                "minLength": 8
              },
              "privProtocol": {
                "description": "privProtocol of the SNMP User.",
                "type": "string",
                "enum": [
                  "NONE",
                  "DES",
                  "AES"
                ]
              },
              "privPassword": {
                "description": "privPassword of the SNMP User.",
                "type": "string",
                "minLength": 8
              },
              "readEnabled": {
                "description": "read privilege of the SNMP User",
                "type": "boolean"
              },
              "writeEnabled": {
                "description": "write privilege of the SNMP User",
                "type": "boolean"
              },
              "notificationEnabled": {
                "description": "notification privilege of the SNMP User",
                "type": "boolean"
              },
              "notificationType": {
                "description": "type of the notification privilege",
                "type": "string",
                "enum": [
                  "TRAP",
                  "INFORM"
                ]
              },
              "notificationTarget": {
                "description": "Trap List of the SNMP User",
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "address": {
                      "description": "address of the SNMP Trap",
                      "type": "string"
                    },
                    "port": {
                      "description": "port number of the SNMP Trap",
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 65535
                    }
                  },
                  "required": [
                    "address",
                    "port"
                  ]
                }
              }
            },
            "required": [
              "userName",
              "readEnabled",
              "writeEnabled",
              "notificationEnabled"
            ]
          }
        }
      }
    },
    "venueProfile": {
      "description": "Venue profile configuration of the AP group.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "channelEvaluationInterval": {
      "description": "channel evaluation Interval of the ap group",
      "type": "integer",
      "minimum": 60,
      "maximum": 3600
    },
    "apMgmtVlan": {
      "description": "ap Management Vlan of the apgroup",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mode": {
          "description": "Vlan Mode of the zone",
          "type": "string",
          "enum": [
            "KEEP",
            "USER_DEFINED"
          ]
        },
        "id": {
          "description": "Vlan id of the zone",
          "type": "integer"
        }
      }
    },
    "recoverySsid": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "recoverySsidEnabled": {
          "description": "recovery ssid enable/disable",
          "type": "boolean"
        }
      }
    },
    "rogueApReportThreshold": {
      "description": "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
      "type": "integer"
    },
    "rogueApAggressivenessMode": {
      "description": "Adjust the frequency interval to de-authenticate rogue APs.",
      "type": "integer"
    },
    "rogueApJammingThreshold": {
      "type": "integer"
    },
    "directedMulticastFromWiredClientEnabled": {
      "description": "Directed multicast from wired client to network.",
      "type": "boolean"
    },
    "directedMulticastFromWirelessClientEnabled": {
      "description": "Directed multicast from wireless client to network.",
      "type": "boolean"
    },
    "directedMulticastFromNetworkEnabled": {
      "description": "Directed multicast from network to wired / wireless client.",
      "type": "boolean"
    },
    "lteBandLockChannels": {
      "description": "LTE band lock channels options",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "simCardId": {
            "description": "SIM card ID(Primary:0, Secondary:1)",
            "type": "integer"
          },
          "type": {
            "description": "LTE chipset SKU type",
            "type": "string"
          },
          "channel4g": {
            "description": "LTE 4G channels",
            "type": "string"
          },
          "channel3g": {
            "description": "LTE 3G channels",
            "type": "string"
          }
        }
      }
    },
    "monitoringEnabled": {
      "description": "Set AP group as monitoring group.",
      "type": "boolean"
    },
    "apGroupRoguePolicy": {
      "description": "Override Rogue AP policy ID (only for monitoring group).",
      "type": "string"
    },
    "rogueScanFreq": {
      "description": "Set rogue scan frequency (only for monitoring group).",
      "type": "string",
      "enum": [
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    },
    "paloAltoFirewallProfileOverrided": {
      "type": "boolean"
    },
    "paloAltoFirewallProfileId": {
      "type": "string"
    },
    "rksGreForwardBroadcast": {
      "description": "Ruckus GRE tunnel broadcast packet forwarding",
      "type": "boolean"
    },
    "bssColoringEnable": {
      "description": "Turn on/off BSS coloring mechanism.",
      "type": "boolean"
    },
    "radioConfig": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "radio24g": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ]
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40
              ]
            },
            "channel": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "minItems": 1
            },
            "wlanGroupId": {
              "type": "string"
            },
            "protectionMode": {
              "type": "string",
              "enum": [
                "NONE",
                "CTS_ONLY",
                "RTS_CTS"
              ]
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ]
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio5g": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ]
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ]
            },
            "channel": {
              "type": "integer"
            },
            "channelIndoor": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "minItems": 1
            },
            "channelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "secondaryChannel": {
              "type": "integer"
            },
            "secondaryChannelIndoor": {
              "type": "integer"
            },
            "wlanGroupId": {
              "type": "string"
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ]
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio5gLower": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ]
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ]
            },
            "channel": {
              "type": "integer"
            },
            "channelIndoor": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "minItems": 1
            },
            "channelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "secondaryChannel": {
              "type": "integer"
            },
            "secondaryChannelIndoor": {
              "type": "integer"
            },
            "wlanGroupId": {
              "type": "string"
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ]
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio5gUpper": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ]
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ]
            },
            "channel": {
              "type": "integer"
            },
            "channelIndoor": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "minItems": 1
            },
            "channelRangeIndoor": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "secondaryChannel": {
              "type": "integer"
            },
            "secondaryChannelIndoor": {
              "type": "integer"
            },
            "wlanGroupId": {
              "type": "string"
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ]
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            }
          }
        },
        "radio6g": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "autoCellSizing": {
              "type": "boolean"
            },
            "txPower": {
              "type": "string",
              "enum": [
                "Full",
                "-1dB",
                "-2dB",
                "-3dB(1/2)",
                "-4dB",
                "-5dB",
                "-6dB(1/4)",
                "-7dB",
                "-8dB",
                "-9dB(1/8)",
                "-10dB",
                "Min"
              ]
            },
            "channelWidth": {
              "type": "integer",
              "enum": [
                0,
                20,
                40,
                80,
                8080,
                160
              ]
            },
            "channel": {
              "type": "integer"
            },
            "channelRange": {
              "type": "array",
              "items": {
                "type": "integer"
              },
              "minItems": 1
            },
            "wlanGroupId": {
              "type": "string"
            },
            "autoChannelSelection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "channelSelectMode": {
                  "type": "string",
                  "enum": [
                    "None",
                    "BackgroundScanning",
                    "ChannelFly"
                  ]
                },
                "channelFlyMtbc": {
                  "type": "integer",
                  "minimum": 100,
                  "maximum": 1440
                },
                "channelFlyChangeFrequency": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                },
                "channelFlyOptimizationTimePeriod": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                  }
                }
              }
            },
            "bssMinRate": {
              "description": "6G BSS minimum rate (mbps)",
              "type": "string",
              "enum": [
                "HE-MCS0",
                "HE-MCS1",
                "HE-MCS2",
                "HE-MCS3"
              ]
            },
            "mgmtTxRate": {
              "description": "6G management TX rate (mbps)",
              "type": "string",
              "enum": [
                "6 mbps",
                "9 mbps",
                "12 mbps",
                "18 mbps",
                "24 mbps",
                "36 mbps",
                "48 mbps",
                "54 mbps"
              ]
            },
            "multicastUplinkRateLimit": {
              "description": "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
              "type": "integer",
              "minimum": 0,
              "maximum": 100
            },
            "multicastDownlinkRateLimit": {
              "description": "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
              "type": "integer",
              "minimum": 0,
              "maximum": 100
            }
          }
        },
        "dual5gEnabled": {
          "type": "boolean"
        }
      }
    }
  }
}
Response  204

Delete

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

Use this API command to delete an AP group.

Response  204

Disable Location Override

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

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

Response  204

Disable Location AdditionalInfo Override

DELETE/v11_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

Disable Location Based Service Override

DELETE/v11_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

Disable Client Admission Control 2.4G Override

DELETE/v11_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

Disable Client Admission Control 5G Override

DELETE/v11_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

Clear Hotspot2.0 Venue Profile

DELETE/v11_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

Disable Channel Evaluation Interval Override

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

Disable Channel Evaluation Interval Override of an AP group.

Response  204

Disable AP Management Vlan Override

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

Disable AP Management Vlan Override of an AP group.

Response  204

Disable Altitude of ApGroup

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

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

Response  204

Disable WLAN group 2.4G Override

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable WLAN group 5G Override

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 2.4G Override

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 5G Override

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

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 2.4G Auto ChannelSelectMode Override

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

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 5G Auto ChannelSelectMode Override

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

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 2.4G TxPower Override

DELETE/v11_0/rkszones/{zoneId}/apgroups/{id}/wifi24/txPower

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 5G TxPower Override

DELETE/v11_0/rkszones/{zoneId}/apgroups/{id}/wifi50/txPower

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 2.4G ChannelWidth Override

DELETE/v11_0/rkszones/{zoneId}/apgroups/{id}/wifi24/channelWidth

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 2.4G Channel Override

DELETE/v11_0/rkszones/{zoneId}/apgroups/{id}/wifi24/channel

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 2.4G ChannelRange Override

DELETE/v11_0/rkszones/{zoneId}/apgroups/{id}/wifi24/channelRange

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 5G ChannelWidth Override

DELETE/v11_0/rkszones/{zoneId}/apgroups/{id}/wifi50/channelWidth

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 5G IndoorChannel Override

DELETE/v11_0/rkszones/{zoneId}/apgroups/{id}/wifi50/indoorChannel

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 5G OutdoorChannel Override

DELETE/v11_0/rkszones/{zoneId}/apgroups/{id}/wifi50/outdoorChannel

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 5G IndoorChannelRange Override

DELETE/v11_0/rkszones/{zoneId}/apgroups/{id}/wifi50/indoorChannelRange

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 5G OutdoorChannelRange Override

DELETE/v11_0/rkszones/{zoneId}/apgroups/{id}/wifi50/outdoorChannelRange

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 2.4G Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio24g

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

Response  204

Disable Radio 5G Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5g

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

Response  204

Disable Radio Lower 5G Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gLower

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

Response  204

Disable Radio Upper 5G Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gUpper

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

Response  204

Disable Radio 6G Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio6g

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

Response  204

Disable Radio 2.4G TxPower Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio24g/txPower

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

Response  204

Disable Radio 5G TxPower Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5g/txPower

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

Response  204

Disable Radio Lower 5G TxPower Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gLower/txPower

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

Response  204

Disable Radio Upper 5G TxPower Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gUpper/txPower

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

Response  204

Disable Radio 6G TxPower Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio6g/txPower

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

Response  204

Disable Radio 2.4G ChannelWidth Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio24g/channelWidth

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

Response  204

Disable Radio 2.4G Channel Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio24g/channel

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

Response  204

Disable Radio 2.4G ChannelRange Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio24g/channelRange

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

Response  204

Disable Radio 5G ChannelWidth Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5g/channelWidth

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

Response  204

Disable Radio 5G IndoorChannel Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5g/channelIndoor

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

Response  204

Disable Radio 5G OutdoorChannel Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5g/channel

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

Response  204

Disable Radio 5G IndoorChannelRange Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5g/channelRangeIndoor

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

Response  204

Disable Radio 5G OutdoorChannelRange Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5g/channelRange

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

Response  204

Disable Radio Lower 5G ChannelWidth Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gLower/channelWidth

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

Response  204

Disable Radio Lower 5G IndoorChannel Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gLower/channelIndoor

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

Response  204

Disable Radio Lower 5G OutdoorChannel Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gLower/channel

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

Response  204

Disable Radio Lower 5G IndoorChannelRange Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gLower/channelRangeIndoor

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

Response  204

Disable Radio Lower 5G OutdoorChannelRange Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gLower/channelRange

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

Response  204

Disable Radio Upper 5G ChannelWidth Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gUpper/channelWidth

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

Response  204

Disable Radio Upper 5G IndoorChannel Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gUpper/channelIndoor

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

Response  204

Disable Radio Upper 5G OutdoorChannel Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gUpper/channel

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

Response  204

Disable Radio Upper 5G IndoorChannelRange Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gUpper/channelRangeIndoor

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

Response  204

Disable Radio Upper 5G OutdoorChannelRange Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gUpper/channelRange

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

Response  204

Disable Radio 6G ChannelWidth Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio6g/channelWidth

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

Response  204

Disable Radio 6G Channel Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio6g/channel

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

Response  204

Disable Radio 6G ChannelRange Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio6g/channelRange

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

Response  204

Disable WLAN group 2.4G Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio24g/wlanGroupId

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

Response  204

Disable WLAN group 5G Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5g/wlanGroupId

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

Response  204

Disable WLAN group lower 5G Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gLower/wlanGroupId

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

Response  204

Disable WLAN group upper 5G Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gUpper/wlanGroupId

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

Response  204

Disable WLAN group 6G Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio6g/wlanGroupId

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

Response  204

Disable 6G BSS Minimum Rate Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio6g/bssMinRate

Use this API command to disable 6G BSS minimum rate override for APs that belong to an AP group. This will also disable the override of 6G multicast downlink rate limit.

Response  204

Disable 6G Management TX Rate Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio6g/mgmtTxRate

Use this API command to disable 6G management TX rate override for APs that belong to an AP group.

Response  204

Disable 2.4GHz radio protection mode override.

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio24g/protectionMode

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

Response  204

Disable Radio 2.4G Auto ChannelSelectMode Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio24g/autoChannelSelection

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

Response  204

Disable Radio 5G Auto ChannelSelectMode Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5g/autoChannelSelection

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

Response  204

Disable Radio Lower 5G Auto ChannelSelectMode Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gLower/autoChannelSelection

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

Response  204

Disable Radio Upper 5G Auto ChannelSelectMode Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio5gUpper/autoChannelSelection

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

Response  204

Disable Radio 6G Auto ChannelSelectMode Override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/radioConfig/radio6g/autoChannelSelection

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

Response  204

Disable 2.4GHz radio protection mode override.

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/protectionMode24

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

Response  204

Disable Recovery SSID override.

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/recoverySsid

Use this API command to disable Recovery SSID configuration override zone for APs that belong to an AP group.

Response  204

Disable Directed Multicast from wired client to Network

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/directedMulticastFromWiredClientEnabled

Use this API command to disable Directed Multicast from wired client to Network configuration override zone for APs that belong to an AP group.

Response  204

Disable Directed Multicast from wireless client to Network

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/directedMulticastFromWirelessClientEnabled

Use this API command to disable Directed Multicast from wireless client to Network configuration override zone for APs that belong to an AP group.

Response  204

Disable Directed Multicast from Network to wired/wireless client

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/directedMulticastFromNetworkEnabled

Use this API command to disable Directed Multicast from Network to wired/wireless client configuration override zone for APs that belong to an AP group.

Response  204

Disable rogue AP report threshold override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/rogueApReportThreshold

Use this API command to disable rogue AP report threshold override zone for APs that belong to an AP group.

Response  204

Disable rogue AP aggressiveness mode override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/rogueApAggressivenessMode

Use this API command to disable rogue AP aggressiveness mode override zone for APs that belong to an AP group.

Response  204

Disable rogue AP jamming threshold override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/rogueApJammingThreshold

Use this API command to disable rogue AP jamming threshold override zone for APs that belong to an AP group.

Response  204

Disable LTE band lock channel override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/lteBandLockChannels

Use this API command to disable LTE band lock channel override zone for APs that belong to an AP group.

Response  204

Disable Ruckus GRE Broadcast packet forwarding override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/rksGreForwardBroadcast

Use this API command to disable Ruckus GRE Broadcast packet forwarding override zone for APs that belong to an AP group.

Response  204

Disable AWS venue override

DELETE/v11_1/rkszones/{zoneId}/apgroups/{id}/awsVenue

Use this API command to disable AWS venue override. The AP will apply its group’s or zone’s configuration.

Response  204

Remove Member

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

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

Response  204

Disable Override AP Model

DELETE/v11_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

Access Point Configuration

Retrieve

GET/v11_1/aps/{apMac}

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

Response  200
HideShow
Body
{
  "zoneId": "zoneUUID",
  "apGroupId": "apGroupUUID",
  "serial": "00000096",
  "model": "ZF7343",
  "name": "apName",
  "gpsSource": "MANUAL",
  "latitude": 22.3,
  "longitude": 114,
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "description": "apDescription",
  "administrativeState": "Unlocked",
  "provisionChecklist": "provisionChecklist",
  "login": {
    "apLoginName": "apLoginName",
    "apLoginPassword": "apLoginPassword"
  },
  "radioConfig": {
    "radio24g": {
      "autoCellSizing": false,
      "txPower": "-4dB",
      "channelWidth": 40,
      "channel": 3,
      "channelRange": [
        1,
        2,
        3
      ],
      "availableChannelRange": [],
      "wlanGroupId": null,
      "wlanServiceEnabled": true,
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      },
      "protectionMode": "CTS_ONLY"
    },
    "radio5g": {
      "autoCellSizing": false,
      "txPower": "-4dB",
      "channelWidth": 40,
      "channel": 3,
      "channelRange": [
        36,
        40,
        44,
        48,
        149,
        153,
        157,
        161
      ],
      "secondaryChannel": null,
      "wlanGroupId": null,
      "wlanServiceEnabled": true,
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 120,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00"
        ]
      }
    },
    "radio5gUpper": null,
    "radio5gLower": null,
    "radio6g": null,
    "dual5gEnabled": null
  },
  "network": {
    "ipType": "Static",
    "ip": "1.1.1.1",
    "netmask": "255.255.255.0",
    "gateway": "1.1.1.0",
    "primaryDns": "8.8.8.8",
    "secondaryDns": "8.8.8.9"
  },
  "networkIpv6": {
    "ipType": "Static",
    "ip": "2001::55/32",
    "gateway": "2001::66",
    "primaryDns": "2001::77",
    "secondaryDns": "2001::88"
  },
  "smartMonitor": {
    "enabled": true,
    "intervalInSec": 10,
    "retryThreshold": 10
  },
  "bonjourGateway": {
    "id": "bonjourGatewayUUID",
    "name": "bonjourGatewayName"
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "specific": {
    "ledStatusEnabled": false,
    "lacp": {
      "keepApSetting": false,
      "enabled": true,
      "bondPortProfileId": "ed395d1c-45a7-4d85-994f-244c38c83f2c"
    },
    "lldp": {
      "enabled": true,
      "advertiseIntervalInSec": 100,
      "holdTimeInSec": 1000,
      "managementIPTLVEnabled": false
    },
    "ledMode": null,
    "internalHeaterEnabled": null,
    "poeOutPortEnabled": null,
    "usbPowerEnable": true,
    "poeModeSetting": "Auto",
    "poeTxChain": 2,
    "radioBand": null,
    "externalAntenna24": null,
    "externalAntenna50": null,
    "lanPorts": [
      {
        "portName": "LAN1",
        "enabled": true,
        "type": "Trunk",
        "vlanUntagId": 13,
        "members": "1-4094",
        "_8021X": {
          "type": "Disable",
          "authenticator": null,
          "supplicant": null
        }
      },
      {
        "portName": "LAN2",
        "enabled": true,
        "type": "Access",
        "vlanUntagId": 15,
        "members": "15",
        "_8021X": {
          "type": "MACBasedAuthenticator",
          "authenticator": {
            "authentication": {
              "id": "5f66275c-b1fd-4e25-a4db-b64115740fb9",
              "name": "zoneRadius"
            },
            "accounting": {
              "id": "b86db5e8-884b-4c90-9315-dcd72acaf743",
              "name": "zoneRadiusAcct"
            },
            "macAuthByPassEnabled": true
          },
          "supplicant": null
        }
      },
      {
        "portName": "LAN3",
        "enabled": true,
        "type": "Trunk",
        "vlanUntagId": 1,
        "members": "1-4094",
        "_8021X": {
          "type": "Supplicant",
          "authenticator": null,
          "supplicant": {
            "type": "Custom",
            "userName": "a",
            "password": "a"
          }
        }
      }
    ]
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "meshOptions": {
    "meshMode": "MESH_AP",
    "uplinkSelection": "MANUAL",
    "meshUplinkEntryList": [
      "6C:AA:B3:26:6C:30"
    ],
    "uplinkRadio": "AUTO"
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "rogueApReportThreshold": 50,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingThreshold": 50,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "rksGreForwardBroadcast": false,
  "swapInMac": "11:22:33:44:55:66",
  "swapOutMac": null
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "mac" : {
            "description" : "MAC address of the AP",
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
        },
        "zoneId" : {
            "description" : "Identifier of the AP group to which the AP belongs",
            "type" : "string"
        },
        "apGroupId" : {
            "type" : "string"
        },
        "serial" : {
            "description" : "Serial number of the AP",
            "type" : "string"
        },
        "model" : {
            "description" : "Model name of the AP",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the AP",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
        },
        "description" : {
            "description" : "Description of the AP",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "gpsSource" : {
            "description" : "GPS Source of the AP",
            "type" : "string",
            "enum" : [ "GPS", "MANUAL" ]
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "location" : {
            "description" : "Location of the AP. It is a text description to indicate the location of the AP.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP.",
            "type" : "string"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "provisionChecklist" : {
            "description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
            "type" : "string"
        },
        "administrativeState" : {
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "type" : "string",
            "enum" : [ "Locked", "Unlocked" ],
            "default" : "Unlocked"
        },
        "login" : {
            "description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "syslog" : {
            "description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Indicates whether syslog is enabled or disabled",
                    "type" : "boolean"
                },
                "syslogConfigType" : {
                    "description" : "Syslog configuration type.",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "syslogServerProfileId" : {
                    "description" : "Syslog server profile ID.",
                    "type" : "string"
                },
                "address" : {
                    "description" : "Address of the syslog server. If syslog is enabled, this attribute is required.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : "514",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : "514",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                }
            },
            "required" : [ "enabled" ]
        },
        "radioConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "radio24g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "availableChannelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "availableChannelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gUpper" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "availableChannelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gLower" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "availableChannelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio6g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "lowPowerIndoorModeEnabled" : {
                            "type" : "boolean"
                        },
                        "availableChannelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        },
                        "bssMinRate" : {
                            "description" : "6G BSS minimum rate (mbps)",
                            "type" : "string",
                            "enum" : [ "HE-MCS0", "HE-MCS1", "HE-MCS2", "HE-MCS3" ]
                        },
                        "mgmtTxRate" : {
                            "description" : "6G management TX rate (mbps)",
                            "type" : "string",
                            "enum" : [ "6 mbps", "9 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
                        },
                        "multicastUplinkRateLimit" : {
                            "description" : "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        },
                        "multicastDownlinkRateLimit" : {
                            "description" : "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        }
                    }
                },
                "dual5gEnabled" : {
                    "type" : "boolean"
                }
            }
        },
        "network" : {
            "description" : "Network settings ipv4 of the AP.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ipType" : {
                    "description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "ip" : {
                    "description" : "IP address of the AP",
                    "type" : "string"
                },
                "netmask" : {
                    "description" : "Netmask of the AP's subnet",
                    "type" : "string",
                    "pattern" : "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
                },
                "gateway" : {
                    "description" : "Gateway of the AP",
                    "type" : "string"
                },
                "primaryDns" : {
                    "description" : "Primary DNS server address of the AP",
                    "type" : "string"
                },
                "secondaryDns" : {
                    "description" : "Secondary DNS server address of the AP",
                    "type" : "string"
                }
            }
        },
        "networkIpv6" : {
            "description" : "Network settings ipv6 of the AP.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ipType" : {
                    "description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "ip" : {
                    "description" : "IP address of the AP",
                    "type" : "string"
                },
                "gateway" : {
                    "description" : "Gateway of the AP",
                    "type" : "string"
                },
                "primaryDns" : {
                    "description" : "Primary DNS server address of the AP",
                    "type" : "string"
                },
                "secondaryDns" : {
                    "description" : "Secondary DNS server address of the AP",
                    "type" : "string"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor of the AP.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "bonjourGateway" : {
            "description" : "Bonjour gateway of the AP.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "Client admission control configuration of 2.4GHz radio of the AP.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "Client admission control configuration of 5GHz radio of the AP.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpConfigType" : {
                    "description" : "The config type of SNMP",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SNMP_AGENT_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "apSnmpAgentProfileId" : {
                    "type" : "string"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the AP.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the AP",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "specific" : {
            "description" : "Model specific configuration of the AP",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ledStatusEnabled" : {
                    "type" : [ "boolean", "null" ]
                },
                "lldp" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "enabled" : {
                            "type" : "boolean",
                            "default" : true
                        },
                        "advertiseIntervalInSec" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 1,
                            "maximum" : 300
                        },
                        "holdTimeInSec" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 60,
                            "maximum" : 1200
                        },
                        "managementIPTLVEnabled" : {
                            "type" : [ "boolean", "null" ]
                        }
                    },
                    "required" : [ "enabled" ]
                },
                "lacp" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "keepApSetting" : {
                            "type" : "boolean"
                        },
                        "enabled" : {
                            "type" : "boolean"
                        },
                        "bondPortProfileId" : {
                            "type" : [ "string", "null" ]
                        }
                    }
                },
                "cellularSettings" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "mobileAPName" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 100,
                            "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
                        },
                        "mobileAPName2" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 100,
                            "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
                        },
                        "simCardUsage" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 2
                        },
                        "select3g4g" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 2
                        },
                        "select3g4g2" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 2
                        },
                        "dataRoaming" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 1
                        },
                        "dataRoaming2" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 1
                        },
                        "wanConnection" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 3
                        },
                        "wanRecoveryTimer" : {
                            "type" : "integer",
                            "minimum" : 10,
                            "maximum" : 300
                        }
                    },
                    "required" : [ "select3g4g", "select3g4g2", "wanConnection", "wanRecoveryTimer" ]
                },
                "ledMode" : {
                    "type" : [ "string", "null" ],
                    "enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
                },
                "internalHeaterEnabled" : {
                    "type" : [ "boolean", "null" ]
                },
                "poeOutPortEnabled" : {
                    "type" : [ "boolean", "null" ]
                },
                "usbPowerEnable" : {
                    "type" : [ "boolean", "null" ]
                },
                "poeModeSetting" : {
                    "type" : [ "string", "null" ],
                    "enum" : [ "Auto", "_802_3af", "_802_3at", "_802_3atPlus", "_802_3bt_Class_5", "_802_3bt_Class_6", "_802_3bt_Class_7", "_802_3bt_Class_8", null ]
                },
                "poeTxChain" : {
                    "description" : "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
                    "default" : 2,
                    "type" : [ "integer", "null" ]
                },
                "radioBand" : {
                    "description" : "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
                    "type" : [ "string", "null" ],
                    "enum" : [ null, "2.4GHz", "5GHz" ]
                },
                "externalAntenna24" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "enabled" : {
                            "type" : "boolean"
                        },
                        "dbi" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 90
                        },
                        "chainMask" : {
                            "type" : [ "string", "null" ],
                            "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" : {
                            "type" : [ "string", "null" ],
                            "enum" : [ null, "Two", "Three" ]
                        }
                    },
                    "required" : [ "enabled" ]
                },
                "lanPorts" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "portName" : {
                                "type" : "string",
                                "enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
                            },
                            "enabled" : {
                                "type" : "boolean"
                            },
                            "overwriteVlanEnabled" : {
                                "description" : "When overwriteVlanEnabled is true, vlanUntagId and members will override ethPortProfile",
                                "type" : "boolean"
                            },
                            "vlanUntagId" : {
                                "type" : [ "integer", "null" ],
                                "minimum" : 0,
                                "maximum" : 4094
                            },
                            "members" : {
                                "type" : [ "string", "null" ]
                            },
                            "ethPortProfile" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "id" : {
                                        "type" : "string"
                                    },
                                    "name" : {
                                        "type" : "string"
                                    }
                                }
                            }
                        },
                        "required" : [ "portName", "enabled" ]
                    }
                }
            }
        },
        "meshOptions" : {
            "description" : "mesh options",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "meshMode" : {
                    "description" : "mesh mode",
                    "type" : "string",
                    "enum" : [ "AUTO", "ROOT_AP", "MESH_AP", "DISABLE" ]
                },
                "uplinkSelection" : {
                    "description" : "Uplink selection",
                    "type" : "string",
                    "enum" : [ "SMART", "MANUAL" ]
                },
                "meshUplinkEntryList" : {
                    "description" : "MAC address of the neighbor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                    }
                },
                "uplinkRadio" : {
                    "description" : "The radio being used to establish mesh link with available neighbor",
                    "type" : "string",
                    "enum" : [ "AUTO", "SECOND_RADIO", "THIRD_RADIO" ]
                }
            }
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "type" : "boolean"
        },
        "lteBandLockChannels" : {
            "description" : "LTE band lock channels options",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "rksGreForwardBroadcast" : {
            "description" : "Ruckus GRE tunnel broadcast packet forwarding",
            "type" : "boolean"
        },
        "testSpeedEnabled" : {
            "description" : "Test Speed is enabled or disabled",
            "type" : "boolean"
        },
        "swapInMac" : {
            "type" : "string"
        },
        "swapOutMac" : {
            "type" : "string"
        },
        "bssColoringEnable" : {
            "description" : "BSS Coloring mechanism enabled.",
            "type" : "boolean"
        }
    }
}

Retrieve AP Picture

GET/v11_1/aps/{apMac}/picture

Use this API command to retrieve the current AP picture.

Response  200
HideShow
Headers
Content-Type: application/octet-stream

Download AP support log

GET/v11_1/aps/{apMac}/supportLog

Use this API command to download AP support log.

Response  200
HideShow
Headers
Content-Type: application/octet-stream

Retrieve List

GET/v11_1/aps

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

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

zoneId
string (optional) 

filter AP list by zone

domainId
string (optional) 

filter AP list by domain. Default: current logon domain

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "mac": "00:11:22:33:44:55",
      "zoneId": "zoneUUID",
      "apGroupId": "apGroupUUID",
      "name": "apName",
      "lanPortSize": 2
    },
    {
      "mac": "11:22:33:44:55:66",
      "zoneId": "zoneUUID2",
      "apGroupId": "apGroupUUID2",
      "name": "apName2",
      "lanPortSize": 1
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total AP count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more APs after the list that is currently displayed",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first AP returned out of the complete AP list",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "mac": {
            "description": "MAC address of the AP",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "zoneId": {
            "description": "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"
          },
          "serial": {
            "description": "Serial Number",
            "type": "string"
          }
        }
      }
    }
  }
}

Query Zero Touch Unapproved AP list

GET/v11_1/mesh/zeroTouch

Use this API command to retrieve a list of unapproved AP.

Response  200
HideShow
Body
{
  "rawDataTotalCount": 100,
  "totalCount": 10,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "apMac": "AB:CD:00:00:00:0D",
      "meshRole": "eMesh AP",
      "apName": "AP014",
      "apModel": "R500",
      "ipAddress": "192.168.0.162",
      "externalIPAddress": "10.10.10.33:3000",
      "channel": null,
      "uplinkRssi": 77,
      "downlinkRssi": null,
      "hasDownLink": false,
      "clientCount": 0,
      "hops": 0,
      "uplinkMCSRate": 50,
      "downlinkMCSRate": null
    }
  ],
  "extra": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "rawDataTotalCount": {
      "description": "MeshNodeInfos count.",
      "type": "integer"
    },
    "totalCount": {
      "description": "MeshNodeInfos count in this response.",
      "type": "integer"
    },
    "extra": {
      "description": "Any additional response data.",
      "type": "object"
    },
    "hasMore": {
      "description": "Indicator of whether there are more MeshNodeInfo after the current displayed list",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first MeshNodeInfo returned out of the complete Rogue AP list",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "apMac": {
            "description": "The MAC of the mesh AP",
            "type": "string"
          },
          "meshRole": {
            "description": "The Role of the mesh AP",
            "type": "string"
          },
          "apName": {
            "description": "The name of the mesh AP",
            "type": "string"
          },
          "apModel": {
            "description": "The model of the mesh AP",
            "type": "string"
          },
          "ipAddress": {
            "description": "The IP of the mesh AP",
            "type": "integer"
          },
          "externalIPAddress": {
            "description": "The external IP of the mesh AP",
            "type": "string"
          },
          "channel": {
            "description": "The channel of the mesh AP",
            "type": "string"
          },
          "uplinkChannel": {
            "description": "The uplink channel of the mesh AP",
            "type": "string"
          },
          "downlinkChannel": {
            "description": "The downlink channel of the mesh AP",
            "type": "string"
          },
          "uplinkSnr": {
            "description": "The uplink SNR of the mesh AP",
            "type": "integer"
          },
          "downlinkSnr": {
            "description": "The downlink SNR of the mesh AP",
            "type": "integer"
          },
          "hasDownLink": {
            "description": "The hasDownLink of the mesh AP",
            "type": "boolean"
          },
          "clientCount": {
            "description": "The count of clients of the mesh AP",
            "type": "integer"
          },
          "hops": {
            "description": "The hop count of this mesh AP",
            "type": "integer"
          },
          "helperZoneInfo": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "helperAPZoneId": {
                  "type": "string"
                },
                "helperAPZoneName": {
                  "type": "string"
                }
              }
            }
          },
          "uplinkMCSRate": {
            "description": "The uplink MCS Rate of the mesh AP",
            "type": "integer"
          },
          "downlinkMCSRate": {
            "description": "The downlink MCS Rate of the mesh AP",
            "type": "integer"
          }
        }
      }
    }
  }
}

Upload AP Picture

POST/v11_1/aps/{apMac}/picture

Use this API command to upload a new AP picture.

Request
HideShow
Headers
Content-Type: multipart/form-data
Response  204

Move multiple APs

POST/v11_1/aps/move

Use this API command to move multiple APs to another Zone/AP Group

Request
HideShow
Body
{
  "targetZoneId": "ZoneId",
  "apMacs": [
    "00:11:22:33:44:55",
    "11:11:22:33:44:55"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "targetZoneId": {
      "description": "Target Zone Id for moving multiple APs",
      "type": "string"
    },
    "targetApGroupId": {
      "description": "Target AP Group Id for moving multiple APs. The target AP group should be under the target Zone.",
      "type": "string"
    },
    "apMacs": {
      "description": "List of AP MAC which wants to move. Maximum of AP MACs: 50.",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "targetZoneId",
    "apMacs"
  ]
}
Response  200
HideShow
Body
{
  "successApCount": 2,
  "failAps": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "successApCount": {
      "description": "Number of AP moved successfully.",
      "type": "integer"
    },
    "failAps": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "count": {
          "description": "Number of AP moved failures.",
          "type": "integer"
        },
        "aps": {
          "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])$"
              },
              "errorMessage": {
                "description": "The error message that move failed.",
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}

Create

POST/v11_1/aps

Use this API command to create a new access point.

Request
HideShow
Body
{
  "mac": "00:11:22:33:44:55",
  "zoneId": "zoneUUID",
  "apGroupId": "apGroupUUID",
  "serial": "00000096",
  "model": "ZF7962",
  "name": "apName",
  "gpsSource": "MANUAL",
  "latitude": 22.3,
  "longitude": 114,
  "location": "shenzhen",
  "description": "apDescription",
  "administrativeState": "Unlocked",
  "provisionChecklist": "test",
  "bssColoringEnable": true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "mac" : {
            "description" : "MAC address of the AP",
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
        },
        "zoneId" : {
            "description" : "Identifier of the zone to which the AP belongs",
            "type" : "string"
        },
        "apGroupId" : {
            "description" : "Identifier of the AP group to which the AP belongs. If the AP belongs to the default AP group, this property is not needed.",
            "type" : "string"
        },
        "serial" : {
            "description" : "Serial number of the AP",
            "type" : "string"
        },
        "model" : {
            "description" : "Model name of the AP",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the AP",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
        },
        "gpsSource" : {
            "description" : "GPS Source of the AP",
            "type" : "string",
            "enum" : [ "GPS", "MANUAL" ]
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "location" : {
            "description" : "Location of the AP. This is a free format text description that indicates the location of the AP.",
            "type" : "string"
        },
        "description" : {
            "description" : "Description of the AP",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "administrativeState" : {
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "type" : "string",
            "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"
        },
        "testSpeedEnabled" : {
            "description" : "Test Speed is enabled or disabled",
            "type" : "boolean"
        },
        "bssColoringEnable" : {
            "description" : "Turn on/off BSS Coloring mechanism.",
            "type" : "boolean"
        }
    },
    "required" : [ "mac", "zoneId" ]
}
Response  201

Sync Provision APs to Cloud Service

POST/v11_1/aps/syncProvisionApsToCloudService

Use this API command to sync provision APs to Cloud Service

Response  200
HideShow
Body
{
  "syncedCount": 88
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "syncedCount" : {
            "description" : "Number of synced provisions APs",
            "type" : "integer"
        },
        "failAps" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "count" : {
                    "description" : "Number of failed provisions APs",
                    "type" : "integer"
                },
                "aps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "mac" : {
                                "type" : "string",
                                "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$"
                            },
                            "serial" : {
                                "type" : "string",
                                "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])|(\d+)$"
                            },
                            "errorMessage" : {
                                "description" : "The error message of failed provisions AP",
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        }
    }
}

Swap in specific AP

POST/v11_1/swapAps

Use this API command to swap in specific AP

Request
HideShow
Body
{
  "swapInMac": "11:22:33:44:55:66",
  "swapOutMac": "55:66:77:88:99:00"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "swapInMac": {
      "description": "Swap in AP's mac address",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
    },
    "swapOutMac": {
      "description": "Swap out AP's mac address",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
    }
  },
  "required": [
    "swapInMac",
    "swapOutMac"
  ]
}
Response  204

Modify Entire

PUT/v11_1/aps/{apMac}

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

Request
HideShow
Body
{
  "zoneId": "zoneUUID",
  "apGroupId": "apGroupUUID",
  "serial": "00000096",
  "model": "ZF7343",
  "name": "apName",
  "gpsSource": "MANUAL",
  "latitude": 22.3,
  "longitude": 114,
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "description": "apDescription",
  "administrativeState": "Unlocked",
  "provisionChecklist": "provisionChecklist",
  "login": {
    "apLoginName": "apLoginName",
    "apLoginPassword": "test1@pwd"
  },
  "syslog": {
    "enabled": true,
    "syslogConfigType": "CUSTOM",
    "syslogServerProfileId": "",
    "address": "1.1.1.1",
    "port": 514,
    "facility": "Keep_Original",
    "priority": "Error",
    "flowLevel": "GENERAL_LOGS",
    "protocol": "IPPROTO_TCP"
  },
  "radioConfig": {
    "radio24g": {
      "txPower": "Full",
      "channelWidth": 20,
      "channel": 1,
      "channelRange": [
        1,
        2,
        3
      ],
      "wlanGroupId": "3b779e31-4469-11e8-823e-3e3d08a406ec",
      "wlanServiceEnabled": true,
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 300,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00",
          "04:00-05:00"
        ]
      },
      "protectionMode": "CTS_ONLY"
    },
    "radio5g": {
      "txPower": "Full",
      "channelWidth": 20,
      "channel": 52,
      "channelRange": [
        52,
        56,
        60
      ],
      "wlanGroupId": "4550acd1-4469-11e8-823e-3e3d08a406ec",
      "wlanServiceEnabled": true,
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 300,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00",
          "04:00-05:00"
        ]
      }
    }
  },
  "network": {
    "ipType": "Static",
    "ip": "1.1.1.1",
    "netmask": "255.255.255.0",
    "gateway": "1.1.1.0",
    "primaryDns": "8.8.8.8",
    "secondaryDns": "8.8.8.9"
  },
  "networkIpv6": {
    "ipType": "Static",
    "ip": "2001::55/32",
    "gateway": "2001::66",
    "primaryDns": "2001::77",
    "secondaryDns": "2001::88"
  },
  "smartMonitor": {
    "enabled": true,
    "intervalInSec": 10,
    "retryThreshold": 10
  },
  "bonjourGateway": {
    "id": "bonjourGatewayUUID",
    "name": "bonjourGatewayName"
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "venueProfile": {
    "id": "venueProfileId",
    "name": "venueProfileName"
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "meshOptions": {
    "meshMode": "MESH_AP",
    "uplinkSelection": "MANUAL",
    "meshUplinkEntryList": [
      "6C:AA:B3:26:6C:30"
    ],
    "uplinkRadio": "AUTO"
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "rogueApReportThreshold": 50,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingThreshold": 50,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "userLocationInfo": {
    "areaCode": 886
  },
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "type": "EC25E",
      "channel4g": "B1,B3,B5",
      "channel3g": "B5"
    },
    {
      "simCardId": 1,
      "type": "EC25E",
      "channel4g": "",
      "channel3g": ""
    }
  ],
  "bssColoringEnable": false
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "zoneId" : {
            "description" : "Identifier of the zone to which the AP belongs",
            "type" : "string"
        },
        "apGroupId" : {
            "description" : "Identifier of the AP group to which the AP belongs",
            "type" : "string"
        },
        "serial" : {
            "description" : "Serial number of the AP",
            "type" : "string"
        },
        "model" : {
            "description" : "Model name of the AP",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the AP",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
        },
        "gpsSource" : {
            "description" : "GPS Source of the AP",
            "type" : "string",
            "enum" : [ "GPS", "MANUAL" ]
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "location" : {
            "description" : "Location of the AP. This is a text description that indicates the location of the AP.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP.",
            "type" : "string"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "description" : {
            "description" : "Description of the AP",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "administrativeState" : {
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "type" : "string",
            "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"
        },
        "login" : {
            "description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "syslog" : {
            "description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Indicates whether syslog is enabled or disabled",
                    "type" : "boolean"
                },
                "syslogConfigType" : {
                    "description" : "Syslog configuration type.",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ]
                },
                "syslogServerProfileId" : {
                    "description" : "Syslog server profile ID.",
                    "type" : "string"
                },
                "address" : {
                    "description" : "Address of the syslog server. If syslog is enabled, this attribute is required.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "radioConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "radio24g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gUpper" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gLower" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio6g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        },
                        "bssMinRate" : {
                            "description" : "6G BSS minimum rate (mbps)",
                            "type" : "string",
                            "enum" : [ "HE-MCS0", "HE-MCS1", "HE-MCS2", "HE-MCS3" ]
                        },
                        "mgmtTxRate" : {
                            "description" : "6G management TX rate (mbps)",
                            "type" : "string",
                            "enum" : [ "6 mbps", "9 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
                        },
                        "multicastUplinkRateLimit" : {
                            "description" : "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        },
                        "multicastDownlinkRateLimit" : {
                            "description" : "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        }
                    }
                },
                "dual5gEnabled" : {
                    "type" : "boolean"
                }
            }
        },
        "network" : {
            "description" : "Network settings ipv4 of the AP.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ipType" : {
                    "description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "ip" : {
                    "description" : "IP address of the AP",
                    "type" : "string"
                },
                "netmask" : {
                    "description" : "Netmask of the AP's subnet",
                    "type" : "string",
                    "pattern" : "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
                },
                "gateway" : {
                    "description" : "Gateway of the AP",
                    "type" : "string"
                },
                "primaryDns" : {
                    "description" : "Primary DNS server address of the AP",
                    "type" : "string"
                },
                "secondaryDns" : {
                    "description" : "Secondary DNS server address of the AP",
                    "type" : "string"
                }
            }
        },
        "networkIpv6" : {
            "description" : "Network settings ipv6 of the AP.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ipType" : {
                    "description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "ip" : {
                    "description" : "IP address of the AP",
                    "type" : "string"
                },
                "gateway" : {
                    "description" : "Gateway of the AP",
                    "type" : "string"
                },
                "primaryDns" : {
                    "description" : "Primary DNS server address of the AP",
                    "type" : "string"
                },
                "secondaryDns" : {
                    "description" : "Secondary DNS server address of the AP",
                    "type" : "string"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor of the AP.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "bonjourGateway" : {
            "description" : "Bonjour gateway of the AP.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "Client admission control configuration of 2.4GHz radio of the AP.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "Client admission control configuration of 5GHz radio of the AP.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpConfigType" : {
                    "description" : "The config type of SNMP",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SNMP_AGENT_PROFILE" ]
                },
                "apSnmpAgentProfileId" : {
                    "type" : "string"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the AP.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the AP",
            "type" : "integer",
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            }
        },
        "meshOptions" : {
            "description" : "mesh options",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "meshMode" : {
                    "description" : "mesh mode",
                    "type" : "string",
                    "enum" : [ "AUTO", "ROOT_AP", "MESH_AP", "DISABLE" ]
                },
                "uplinkSelection" : {
                    "description" : "Uplink selection",
                    "type" : "string",
                    "enum" : [ "SMART", "MANUAL" ]
                },
                "meshUplinkEntryList" : {
                    "description" : "MAC address of the neighbor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                    }
                },
                "uplinkRadio" : {
                    "description" : "The radio being used to establish mesh link with available neighbor",
                    "type" : "string",
                    "enum" : [ "AUTO", "SECOND_RADIO", "THIRD_RADIO" ]
                }
            }
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "type" : "boolean"
        },
        "lteBandLockChannels" : {
            "description" : "LTE band lock channels options",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "rksGreForwardBroadcast" : {
            "description" : "Ruckus GRE tunnel broadcast packet forwarding",
            "type" : "boolean"
        },
        "testSpeedEnabled" : {
            "description" : "Test Speed is enabled or disabled",
            "type" : "boolean"
        },
        "bssColoringEnable" : {
            "description" : "=Turn on/off BSS coloring mechanism.",
            "type" : "boolean"
        }
    }
}
Response  204

Reboot

PUT/v11_1/aps/{apMac}/reboot

reboot an access point.

Response  204

Modify Specific

PUT/v11_1/aps/{apMac}/specific

Use this API command to modify specific configuration.

Request
HideShow
Body
{
  "ledStatusEnabled": false,
  "lacp": {
    "keepApSetting": false,
    "enabled": true,
    "bondPortProfileId": "ed395d1c-45a7-4d85-994f-244c38c83f2c"
  },
  "lldp": {
    "enabled": true,
    "advertiseIntervalInSec": 100,
    "holdTimeInSec": 1000,
    "managementIPTLVEnabled": false
  },
  "cellularSettings": {
    "mobileAPName": "internet",
    "mobileAPName2": "internet",
    "simCardUsage": 0,
    "select3g4g": 0,
    "select3g4g2": 0,
    "dataRoaming": 1,
    "dataRoaming2": 1,
    "wanConnection": 0,
    "wanRecoveryTimer": 60
  },
  "ledMode": null,
  "internalHeaterEnabled": null,
  "poeOutPortEnabled": null,
  "usbPowerEnable": true,
  "poeModeSetting": "Auto",
  "poeTxChain": 2,
  "radioBand": null,
  "externalAntenna24": null,
  "externalAntenna50": null,
  "lanPorts": [
    {
      "portName": "LAN3",
      "enabled": true,
      "ethPortProfile": {
        "id": "1"
      },
      "overwriteVlanEnabled": true,
      "vlanUntagId": 1,
      "members": "1"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ledStatusEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "lldp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "advertiseIntervalInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 300
        },
        "holdTimeInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 60,
          "maximum": 1200
        },
        "managementIPTLVEnabled": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lacp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "keepApSetting": {
          "type": "boolean"
        },
        "enabled": {
          "type": "boolean"
        },
        "bondPortProfileId": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "cellularSettings": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mobileAPName": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
        },
        "mobileAPName2": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
        },
        "simCardUsage": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 2
        },
        "select3g4g": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2
        },
        "select3g4g2": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2
        },
        "dataRoaming": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 1
        },
        "dataRoaming2": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 1
        },
        "wanConnection": {
          "type": "integer",
          "minimum": 0,
          "maximum": 3
        },
        "wanRecoveryTimer": {
          "type": "integer",
          "minimum": 10,
          "maximum": 300
        }
      },
      "required": [
        "select3g4g",
        "select3g4g2",
        "wanConnection",
        "wanRecoveryTimer"
      ]
    },
    "ledMode": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        null,
        "CableModem",
        "AccessPoint",
        "CableModem_AccessPoint",
        "CableModem_AccessPoint_DEFAULT",
        "ActiveSurgeProtector",
        "ActiveSurgeProtector_ModemOnline_DEFAULT",
        "Off"
      ]
    },
    "internalHeaterEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeOutPortEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "usbPowerEnable": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeModeSetting": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "Auto",
        "_802_3af",
        "_802_3at",
        "_802_3atPlus",
        "_802_3bt_Class_5",
        "_802_3bt_Class_6",
        "_802_3bt_Class_7",
        "_802_3bt_Class_8",
        null
      ]
    },
    "poeTxChain": {
      "description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
      "type": [
        "integer",
        "null"
      ]
    },
    "radioBand": {
      "description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
      "type": [
        "string",
        "null"
      ],
      "enum": [
        null,
        "2.4GHz",
        "5GHz"
      ]
    },
    "externalAntenna24": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "dbi": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 90
        },
        "chainMask": {
          "type": [
            "string",
            "null"
          ],
          "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": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            null,
            "Two",
            "Three"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lanPorts": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "portName": {
            "type": "string",
            "enum": [
              "LAN1",
              "LAN2",
              "LAN3",
              "LAN4",
              "LAN5"
            ]
          },
          "enabled": {
            "type": "boolean"
          },
          "overwriteVlanEnabled": {
            "description": "When overwriteVlanEnabled is true, vlanUntagId and members will override ethPortProfile",
            "type": "boolean"
          },
          "vlanUntagId": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 0,
            "maximum": 4094
          },
          "members": {
            "type": [
              "string",
              "null"
            ]
          },
          "ethPortProfile": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "portName",
          "enabled"
        ]
      }
    }
  }
}
Response  204

Update Zero Touch Unapproved AP

PUT/v11_1/mesh/zeroTouch

Use this API command to approve/reject unapproved AP. Recommend to deploy 20 island APs to join per batch at the same time.

Request
HideShow
Body
{
  "apMac": "AB:CD:00:00:00:0D",
  "status": "Accept",
  "helperZoneId": "fce48fb7-8b89-49f6-8ce5-f52aecfc81ff",
  "serialNumber": "0089"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apMac": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "Accept",
        "Reject"
      ]
    },
    "helperZoneId": {
      "type": "string"
    },
    "serialNumber": {
      "type": "string"
    }
  }
}
Response  200

Modify

PATCH/v11_1/aps/{apMac}

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

Request
HideShow
Body
{
  "zoneId": "zoneUUID",
  "apGroupId": "apGroupUUID",
  "serial": "00000096",
  "model": "ZF7343",
  "name": "apName",
  "gpsSource": "MANUAL",
  "latitude": 22.3,
  "longitude": 114,
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "description": "apDescription",
  "administrativeState": "Unlocked",
  "provisionChecklist": "provisionChecklist",
  "login": {
    "apLoginName": "apLoginName",
    "apLoginPassword": "test1@pwd"
  },
  "syslog": {
    "enabled": true,
    "syslogConfigType": "CUSTOM",
    "syslogServerProfileId": "",
    "address": "1.1.1.1",
    "port": 514,
    "facility": "Keep_Original",
    "priority": "Error",
    "flowLevel": "GENERAL_LOGS",
    "protocol": "IPPROTO_TCP"
  },
  "radioConfig": {
    "radio24g": {
      "txPower": "Full",
      "channelWidth": 20,
      "channel": 1,
      "channelRange": [
        1,
        2,
        3
      ],
      "wlanGroupId": "3b779e31-4469-11e8-823e-3e3d08a406ec",
      "wlanServiceEnabled": true,
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 300,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00",
          "04:00-05:00"
        ]
      },
      "protectionMode": "CTS_ONLY"
    },
    "radio5g": {
      "txPower": "Full",
      "channelWidth": 20,
      "channel": 52,
      "channelRange": [
        52,
        56,
        60
      ],
      "wlanGroupId": "4550acd1-4469-11e8-823e-3e3d08a406ec",
      "wlanServiceEnabled": true,
      "autoChannelSelection": {
        "channelSelectMode": "ChannelFly",
        "channelFlyMtbc": 300,
        "channelFlyChangeFrequency": 80,
        "channelFlyOptimizationTimePeriod": [
          "02:00-03:00",
          "04:00-05:00"
        ]
      }
    }
  },
  "network": {
    "ipType": "Static",
    "ip": "1.1.1.1",
    "netmask": "255.255.255.0",
    "gateway": "1.1.1.0",
    "primaryDns": "8.8.8.8",
    "secondaryDns": "8.8.8.9"
  },
  "networkIpv6": {
    "ipType": "Static",
    "ip": "2001::55/32",
    "gateway": "2001::66",
    "primaryDns": "2001::77",
    "secondaryDns": "2001::88"
  },
  "smartMonitor": {
    "enabled": true,
    "intervalInSec": 10,
    "retryThreshold": 10
  },
  "bonjourGateway": {
    "id": "bonjourGatewayUUID",
    "name": "bonjourGatewayName"
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "venueProfile": {
    "id": "venueProfileId",
    "name": "venueProfileName"
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "meshOptions": {
    "meshMode": "MESH_AP",
    "uplinkSelection": "MANUAL",
    "meshUplinkEntryList": [
      "6C:AA:B3:26:6C:30"
    ],
    "uplinkRadio": "AUTO"
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "rogueApReportThreshold": 50,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingThreshold": 50,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "userLocationInfo": {
    "areaCode": 886
  },
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "type": "EC25E",
      "channel4g": "B1,B3,B5",
      "channel3g": "B5"
    },
    {
      "simCardId": 1,
      "type": "EC25E",
      "channel4g": "",
      "channel3g": ""
    }
  ],
  "bssColoringEnable": false
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "zoneId" : {
            "description" : "Identifier of the zone to which the AP belongs",
            "type" : "string"
        },
        "apGroupId" : {
            "description" : "Identifier of the AP group to which the AP belongs",
            "type" : "string"
        },
        "serial" : {
            "description" : "Serial number of the AP",
            "type" : "string"
        },
        "model" : {
            "description" : "Model name of the AP",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the AP",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
        },
        "gpsSource" : {
            "description" : "GPS Source of the AP",
            "type" : "string",
            "enum" : [ "GPS", "MANUAL" ]
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "location" : {
            "description" : "Location of the AP. This is a text description that indicates the location of the AP.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP.",
            "type" : "string"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "description" : {
            "description" : "Description of the AP",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "administrativeState" : {
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "type" : "string",
            "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"
        },
        "login" : {
            "description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "syslog" : {
            "description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Indicates whether syslog is enabled or disabled",
                    "type" : "boolean"
                },
                "syslogConfigType" : {
                    "description" : "Syslog configuration type.",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ]
                },
                "syslogServerProfileId" : {
                    "description" : "Syslog server profile ID.",
                    "type" : "string"
                },
                "address" : {
                    "description" : "Address of the syslog server. If syslog is enabled, this attribute is required.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "radioConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "radio24g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gUpper" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gLower" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio6g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        },
                        "bssMinRate" : {
                            "description" : "6G BSS minimum rate (mbps)",
                            "type" : "string",
                            "enum" : [ "HE-MCS0", "HE-MCS1", "HE-MCS2", "HE-MCS3" ]
                        },
                        "mgmtTxRate" : {
                            "description" : "6G management TX rate (mbps)",
                            "type" : "string",
                            "enum" : [ "6 mbps", "9 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
                        },
                        "multicastUplinkRateLimit" : {
                            "description" : "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        },
                        "multicastDownlinkRateLimit" : {
                            "description" : "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100
                        }
                    }
                },
                "dual5gEnabled" : {
                    "type" : "boolean"
                }
            }
        },
        "network" : {
            "description" : "Network settings ipv4 of the AP.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ipType" : {
                    "description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "ip" : {
                    "description" : "IP address of the AP",
                    "type" : "string"
                },
                "netmask" : {
                    "description" : "Netmask of the AP's subnet",
                    "type" : "string",
                    "pattern" : "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
                },
                "gateway" : {
                    "description" : "Gateway of the AP",
                    "type" : "string"
                },
                "primaryDns" : {
                    "description" : "Primary DNS server address of the AP",
                    "type" : "string"
                },
                "secondaryDns" : {
                    "description" : "Secondary DNS server address of the AP",
                    "type" : "string"
                }
            }
        },
        "networkIpv6" : {
            "description" : "Network settings ipv6 of the AP.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ipType" : {
                    "description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "ip" : {
                    "description" : "IP address of the AP",
                    "type" : "string"
                },
                "gateway" : {
                    "description" : "Gateway of the AP",
                    "type" : "string"
                },
                "primaryDns" : {
                    "description" : "Primary DNS server address of the AP",
                    "type" : "string"
                },
                "secondaryDns" : {
                    "description" : "Secondary DNS server address of the AP",
                    "type" : "string"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor of the AP.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "bonjourGateway" : {
            "description" : "Bonjour gateway of the AP.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "Client admission control configuration of 2.4GHz radio of the AP.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "Client admission control configuration of 5GHz radio of the AP.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpConfigType" : {
                    "description" : "The config type of SNMP",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SNMP_AGENT_PROFILE" ]
                },
                "apSnmpAgentProfileId" : {
                    "type" : "string"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the AP.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the AP",
            "type" : "integer",
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            }
        },
        "meshOptions" : {
            "description" : "mesh options",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "meshMode" : {
                    "description" : "mesh mode",
                    "type" : "string",
                    "enum" : [ "AUTO", "ROOT_AP", "MESH_AP", "DISABLE" ]
                },
                "uplinkSelection" : {
                    "description" : "Uplink selection",
                    "type" : "string",
                    "enum" : [ "SMART", "MANUAL" ]
                },
                "meshUplinkEntryList" : {
                    "description" : "MAC address of the neighbor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                    }
                },
                "uplinkRadio" : {
                    "description" : "The radio being used to establish mesh link with available neighbor",
                    "type" : "string",
                    "enum" : [ "AUTO", "SECOND_RADIO", "THIRD_RADIO" ]
                }
            }
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "type" : "boolean"
        },
        "lteBandLockChannels" : {
            "description" : "LTE band lock channels options",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "rksGreForwardBroadcast" : {
            "description" : "Ruckus GRE tunnel broadcast packet forwarding",
            "type" : "boolean"
        },
        "testSpeedEnabled" : {
            "description" : "Test Speed is enabled or disabled",
            "type" : "boolean"
        },
        "bssColoringEnable" : {
            "description" : "=Turn on/off BSS coloring mechanism.",
            "type" : "boolean"
        }
    }
}
Response  204

Disable Login Override

DELETE/v11_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

Disable Syslog Override

DELETE/v11_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

Disable AP Channel Evaluation Interval

DELETE/v11_1/aps/{apMac}/channelEvaluationInterval

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

Response  204

Disable AP Management Vlan Override

DELETE/v11_1/aps/{apMac}/apMgmtVlan

Disable AP Management Vlan Override of an AP.

Response  204

Disable Altitude Override

DELETE/v11_1/aps/{apMac}/altitude

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

Response  204

Delete AP Picture

DELETE/v11_1/aps/{apMac}/picture

Use this API command to delete an AP picture.

Response  204

Disable Location Override

DELETE/v11_1/aps/{apMac}/location

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

Response  204

Disable Location AdditionalInfo Override

DELETE/v11_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

Disable Smart Monitor Override

DELETE/v11_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

Disable Bonjour Gateway Override

DELETE/v11_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

Disable Client Admission Control 2.4G Override

DELETE/v11_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

Disable Client Admission Control 5G Override

DELETE/v11_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

Disable Venue Profile Override

DELETE/v11_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

Disable AP Management GPS Cooordinates

DELETE/v11_1/aps/{apMac}/gpsCoordinates

Disable AP Management GPS Cooordinates of an AP.

Response  204

Disable Mesh Options

DELETE/v11_1/aps/{apMac}/meshOptions

Use this API command to disable mesh options.

Response  204

Disable Specific Override

DELETE/v11_1/aps/{apMac}/specific

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

Response  204

Disable 2.4GHz radio protection mode override.

DELETE/v11_0/aps/{apMac}/protectionMode24

Use this API command to disable 2.4GHz radio protection mode configuration override.The AP will apply its group’s or zone’s configuration.

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Recovery SSID override.

DELETE/v11_1/aps/{apMac}/recoverySsid

Use this API command to disable Recovery SSID configuration override.The AP will apply its group’s or zone’s configuration.

Response  204

Disable Directed Multicast from wired client override.

DELETE/v11_1/aps/{apMac}/directedMulticastFromWiredClientEnabled

Use this API command to disable Island SSID Broadcast enabled configuration override.The AP will apply its group’s or zone’s configuration.

Response  204

Disable Directed Multicast from wireless client override.

DELETE/v11_1/aps/{apMac}/directedMulticastFromWirelessClientEnabled

Use this API command to disable Island SSID Broadcast enabled configuration override.The AP will apply its group’s or zone’s configuration.

Response  204

Disable Directed Multicast from network to wired/wireless client override

DELETE/v11_1/aps/{apMac}/directedMulticastFromNetworkEnabled

Use this API command to disable Directed Multicast from network to wired/wireless client configuration override.The AP will apply its group’s or zone’s configuration.

Response  204

Disable rogue AP report threshold override

DELETE/v11_1/aps/{apMac}/rogueApReportThreshold

Use this API command to disable rogue AP report threshold override. The AP will apply its group’s or zone’s configuration.

Response  204

Disable rogue AP aggressiveness mode override

DELETE/v11_1/aps/{apMac}/rogueApAggressivenessMode

Use this API command to disable rogue AP aggressiveness mode override. The AP will apply its group’s or zone’s configuration.

Response  204

Disable rogue AP jamming threshold override

DELETE/v11_1/aps/{apMac}/rogueApJammingThreshold

Use this API command to disable rogue AP jamming threshold override. The AP will apply its group’s or zone’s configuration.

Response  204

Disable LTE band lock channel override

DELETE/v11_1/aps/{apMac}/lteBandLockChannels

Use this API command to disable LTE band lock channel override. The AP will apply its group’s or zone’s configuration.

Response  204

Disable Ruckus GRE Broadcast packet forwarding override

DELETE/v11_1/aps/{apMac}/rksGreForwardBroadcast

Use this API command to disable Ruckus GRE Broadcast packet forwarding override. The AP will apply its group’s or zone’s configuration.

Response  204

Disable WLAN Group 2.4G Override

DELETE/v11_0/aps/{apMac}/wlanGroup24

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable WLAN group 5G Override

DELETE/v11_0/aps/{apMac}/wlanGroup50

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 2.4G Override

DELETE/v11_0/aps/{apMac}/wifi24

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 5G Override

DELETE/v11_0/aps/{apMac}/wifi50

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 2.4G Auto channel selection

DELETE/v11_0/aps/{apMac}/autoChannelSelection24

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 5G Auto channel selection

DELETE/v11_0/aps/{apMac}/autoChannelSelection50

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 2.4G TxPower Override

DELETE/v11_0/aps/{apMac}/wifi24/txPower

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 5G TxPower Override

DELETE/v11_0/aps/{apMac}/wifi50/txPower

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 2.4G ChannelWidth Override

DELETE/v11_0/aps/{apMac}/wifi24/channelWidth

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 2.4G Channel Override

DELETE/v11_0/aps/{apMac}/wifi24/channel

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 2.4G ChannelRange Override

DELETE/v11_0/aps/{apMac}/wifi24/channelRange

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 5G ChannelWidth Override

DELETE/v11_0/aps/{apMac}/wifi50/channelWidth

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 5G Channel Override

DELETE/v11_0/aps/{apMac}/wifi50/channel

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 5G ChannelRange Override

DELETE/v11_0/aps/{apMac}/wifi50/channelRange

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

Deprecated : this URI will be deprecated after Version: v11_0, and no longer be supported.

Response  204

Disable Radio 2.4G Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio24g

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

Response  204

Disable Radio 5G Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5g

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

Response  204

Disable Radio Lower 5G Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5gLower

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

Response  204

Disable Radio Upper 5G Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5gUpper

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

Response  204

Disable Radio 6G Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio6g

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

Response  204

Disable Radio 2.4G TxPower Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio24g/txPower

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

Response  204

Disable Radio 5G TxPower Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5g/txPower

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

Response  204

Disable Radio Lower 5G TxPower Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5gLower/txPower

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

Response  204

Disable Radio Upper 5G TxPower Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5gUpper/txPower

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

Response  204

Disable Radio 6G TxPower Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio6g/txPower

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

Response  204

Disable Radio 2.4G ChannelWidth Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio24g/channelWidth

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

Response  204

Disable Radio 2.4G Channel Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio24g/channel

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

Response  204

Disable Radio 2.4G ChannelRange Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio24g/channelRange

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

Response  204

Disable Radio 5G ChannelWidth Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5g/channelWidth

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

Response  204

Disable Radio Lower 5G ChannelWidth Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5gLower/channelWidth

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

Response  204

Disable Radio Upper 5G ChannelWidth Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5gUpper/channelWidth

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

Response  204

Disable Radio 6G ChannelWidth Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio6g/channelWidth

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

Response  204

Disable Radio 5G Channel Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5g/channel

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

Response  204

Disable Radio Lower 5G Channel Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5gLower/channel

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

Response  204

Disable Radio Upper 5G Channel Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5gUpper/channel

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

Response  204

Disable Radio 6G Channel Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio6g/channel

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

Response  204

Disable Radio 5G ChannelRange Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5g/channelRange

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

Response  204

Disable Radio Lower 5G ChannelRange Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5gLower/channelRange

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

Response  204

Disable Radio Upper 5G ChannelRange Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5gUpper/channelRange

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

Response  204

Disable Radio 6G ChannelRange Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio6g/channelRange

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

Response  204

Disable WLAN Group 2.4G Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio24g/wlanGroupId

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

Disable WLAN Group 5G Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5g/wlanGroupId

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

Disable WLAN Group Lower 5G Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5gLower/wlanGroupId

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

Response  204

Disable WLAN Group Upper 5G Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio5gUpper/wlanGroupId

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

Response  204

Disable WLAN Group 6G Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio6g/wlanGroupId

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

Response  204

Disable 6G BSS Minimum Rate Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio6g/bssMinRate

Use this API command to disable the AP level override of BSS minimum rate on the 6GHz radio. The access point will take its group’s or zone’s configuration. This will also disable the override of 6G multicast downlink rate limit.

Response  204

Disable 6G Management TX Rate Override

DELETE/v11_1/aps/{apMac}/radioConfig/radio6g/mgmtTxRate

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

Response  204

Disable 2.4GHz radio protection mode override.

DELETE/v11_1/aps/{apMac}/radioConfig/radio24g/protectionMode

Use this API command to disable 2.4GHz radio protection mode configuration override.The AP will apply its group’s or zone’s configuration.

Response  204

Disable Radio 2.4G Auto channel selection

DELETE/v11_1/aps/{apMac}/radioConfig/radio24g/autoChannelSelection

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

Response  204

Disable Radio 5G Auto channel selection

DELETE/v11_1/aps/{apMac}/radioConfig/radio5g/autoChannelSelection

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

Response  204

Disable Radio Lower 5G Auto channel selection

DELETE/v11_1/aps/{apMac}/radioConfig/radio5gLower/autoChannelSelection

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

Response  204

Disable Radio Upper 5G Auto channel selection

DELETE/v11_1/aps/{apMac}/radioConfig/radio5gUpper/autoChannelSelection

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

Response  204

Disable Radio 6G Auto channel selection

DELETE/v11_1/aps/{apMac}/radioConfig/radio6g/autoChannelSelection

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

Response  204

Delete

DELETE/v11_1/aps/{apMac}

Use this API command to delete an access point.

URI Parameters
HideShow
validateMesh
string (optional) 

Validate if AP is not MAP/eMAP. Default: true

Response  204

Access Point Operational

Retrieve Mesh Neighbor AP List

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

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

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

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

Retrieve Operational Information

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

This API provide detailed AP status and configuration, therefore it was designed for single AP information retrieving. If you need to retrieve large number of ap states, please use “POST://query/ap” (refer to the “Query APs” section of the category “Access Point Operational”).

Response  200
HideShow
Body
{
  "mac": "00:11:22:33:44:55",
  "zoneId": "zoneUUID",
  "apGroupId": "apGroupUUID",
  "serial": "00000096",
  "model": "ZF7962",
  "name": "apName",
  "version": "3.0.0.385",
  "description": "apDescription",
  "countryCode": "US",
  "latitude": 22.3,
  "longitude": 114,
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 33
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "cpId": "controlPlaneUUID",
  "dpId": "dataPlaneUUID",
  "wifi24Channel": "2",
  "wifi50Channel": "6",
  "wifi6gChannel": "1",
  "meshRole": "Map",
  "meshHop": 2,
  "ipType": "Static",
  "ip": "1.1.1.1",
  "ipv6Type": null,
  "ipv6": null,
  "externalIp": "172.18.11.11",
  "externalPort": 675,
  "configState": "newConfig",
  "connectionState": "Connected",
  "registrationState": "Approved",
  "administrativeState": "Unlocked",
  "provisionMethod": "Discovered",
  "provisionStage": "Waiting for Registration",
  "isCriticalAP": true,
  "approvedTime": 111111,
  "lastSeenTime": 111111,
  "uptime": 111111,
  "clientCount": 2
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "mac" : {
            "description" : "MAC address of the AP",
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
        },
        "zoneId" : {
            "description" : "Identifier of the zone to which the AP belongs",
            "type" : "string"
        },
        "apGroupId" : {
            "description" : "Identifier of the AP group to which the AP belongs",
            "type" : "string"
        },
        "serial" : {
            "description" : "Serial number of the AP",
            "type" : "string"
        },
        "model" : {
            "description" : "Model name of the AP",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the AP",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
        },
        "description" : {
            "description" : "Description of the AP",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "description" : "Firmware version of the AP",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "description" : "Country code of the AP",
            "type" : "string"
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "location" : {
            "description" : "Location of the AP. This is a text description that indicates the location of the AP.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP.",
            "type" : "string"
        },
        "altitude" : {
            "description" : "GPS Altitude.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "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"
        },
        "wifi6gChannel" : {
            "type" : "string"
        },
        "meshRole" : {
            "description" : "Mesh role of the AP",
            "type" : "string",
            "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.",
            "type" : "string",
            "enum" : [ "Static", "Dynamic", "Keep" ]
        },
        "ip" : {
            "description" : "IP address of the AP",
            "type" : "string"
        },
        "ipv6Type" : {
            "description" : "Indicates how the AP's IP address was obtained. The AP's IP address can be statically or dynamically assigned or kept unchanged.",
            "type" : "string",
            "enum" : [ "Static", "Autoconfig", "Keep" ]
        },
        "ipv6" : {
            "description" : "IP address of the AP",
            "type" : "string"
        },
        "externalIp" : {
            "description" : "External IP address of the AP. This is only applicable when the AP is behind a NAT server.",
            "type" : "string"
        },
        "externalPort" : {
            "description" : "External port number of the AP. This is only applicable when the AP is behind a NAT server.",
            "type" : "integer"
        },
        "configState" : {
            "description" : "State of the AP configuration.",
            "type" : "string",
            "enum" : [ "newConfig", "fwApplied", "fwDownloaded", "fwFailed", "configApplied", "completed", "configFailed" ]
        },
        "connectionState" : {
            "description" : "Connection state of the AP (value: 'Discovery','Connect','Rebooting','Disconnect','Provisioned')",
            "type" : "string"
        },
        "registrationState" : {
            "description" : "Registration state of the AP",
            "type" : "string"
        },
        "administrativeState" : {
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "type" : "string",
            "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.",
            "type" : "string",
            "enum" : [ "Discovered", "Preprovision", "Swap" ]
        },
        "provisionStage" : {
            "description" : "Provisioning stage of the AP. This indicates the stage at which the AP is at in the provisioning process. (value",
            "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",
            "format" : "int64"
        },
        "lastSeenTime" : {
            "description" : "Timestamp of the last successful communication with the AP",
            "type" : "integer",
            "format" : "int64"
        },
        "uptime" : {
            "description" : "Uptime of the AP since it was last rebooted (unit:second)",
            "type" : "integer",
            "format" : "int64"
        },
        "clientCount" : {
            "description" : "Number of clients on the AP",
            "type" : "integer"
        },
        "managementVlan" : {
            "description" : "Management vlan on the AP",
            "type" : "integer"
        }
    }
}

AP packet capture

GET/v11_1/aps/{apMac}/apPacketCapture

Use this API to get AP packet capture status

Response  200
HideShow
Body
{
  "apMac": "A1:B2:C3:D4:E5:F6",
  "captureInterface": "ETH0",
  "hostIp": "192.168.1.1",
  "includedMac": "1A:2B:3C:4D:5E:6F",
  "includedFrameTypes": [
    "MANAGEMENT"
  ],
  "captureMode": "STREAMING",
  "captureState": "Streaming"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apMac": {
      "type": "string",
      "description": "AP MAC address"
    },
    "captureInterface": {
      "type": "string",
      "enum": [
        "RADIO24",
        "RADIO50",
        "ETH0",
        "ETH1",
        "ETH2",
        "ETH3",
        "ETH4",
        "ETH5",
        "ETH6",
        "ETH7"
      ],
      "description": "Capture interface"
    },
    "hostIp": {
      "type": "string",
      "description": "Wireshark host IP"
    },
    "includedMac": {
      "type": "string",
      "description": "MAC filter"
    },
    "includedFrameTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "CONTROL",
          "DATA",
          "MANAGEMENT"
        ]
      },
      "description": "Frame type filter"
    },
    "captureMode": {
      "type": "string",
      "enum": [
        "STREAMING",
        "FILE_CAPTURE"
      ],
      "description": "Capture mode"
    },
    "captureState": {
      "type": "string",
      "description": "Capture state"
    }
  }
}

Switchover AP

POST/v11_1/aps/switchoverCluster

Use this API command to switchover AP to another cluster

Request
HideShow
Body
{
  "ipOrFqdn": "172.18.11.11",
  "apMacList": [
    "01:02:03:11:12:A3",
    "01:02:03:11:13:29",
    "01:02:03:11:13:AF",
    "01:02:03:11:14:35",
    "01:02:03:11:14:BB"
  ],
  "deleteRecord": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ipOrFqdn": {
      "description": "IP or FQDN address of destination cluster, Notice: Once this value been set, clusterName will be ignored.",
      "type": "string"
    },
    "clusterName": {
      "description": "Name of destination cluster, Notice: Once user has set ipOrFqdn, this value will be ignored.",
      "type": "string"
    },
    "apMacList": {
      "type": "array",
      "description": "AP MAC address list",
      "items": {
        "type": "string",
        "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
      }
    },
    "zoneIdList": {
      "description": "Zone ID list for which APs attached to will be switchovered.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "deleteRecord": {
      "description": "Flag to delete AP record after switchover cluster. Default value is false.",
      "type": "boolean"
    }
  }
}
Response  204

AP packet capture startStreaming

POST/v11_1/aps/{apMac}/apPacketCapture/startStreaming

Use this API to start AP packet streaming

Request
HideShow
Body
{
  "captureInterface": "RADIO50",
  "hostIp": "192.168.1.1",
  "includedMac": "1A:2B:3C:4D:5E:6F",
  "includedFrameTypes": [
    "CONTROL",
    "DATA"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "captureInterface": {
      "type": "string",
      "enum": [
        "RADIO24",
        "RADIO50",
        "RADIO60",
        "ETH0",
        "ETH1",
        "ETH2",
        "ETH3",
        "ETH4",
        "ETH5",
        "ETH6",
        "ETH7"
      ],
      "description": "Capture interface"
    },
    "hostIp": {
      "type": "string",
      "description": "Wireshark host IP"
    },
    "includedMac": {
      "type": "string",
      "description": "MAC filter"
    },
    "includedFrameTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "CONTROL",
          "DATA",
          "MANAGEMENT"
        ]
      },
      "description": "Frame type filter"
    }
  },
  "required": [
    "captureInterface"
  ]
}
Response  200
HideShow
Body
{
  "apMac": "A1:B2:C3:D4:E5:F6",
  "captureInterface": "ETH0",
  "hostIp": "192.168.1.1",
  "includedMac": "1A:2B:3C:4D:5E:6F",
  "includedFrameTypes": [
    "MANAGEMENT"
  ],
  "captureMode": "STREAMING",
  "captureState": "Streaming"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apMac": {
      "type": "string",
      "description": "AP MAC address"
    },
    "captureInterface": {
      "type": "string",
      "enum": [
        "RADIO24",
        "RADIO50",
        "ETH0",
        "ETH1",
        "ETH2",
        "ETH3",
        "ETH4",
        "ETH5",
        "ETH6",
        "ETH7"
      ],
      "description": "Capture interface"
    },
    "hostIp": {
      "type": "string",
      "description": "Wireshark host IP"
    },
    "includedMac": {
      "type": "string",
      "description": "MAC filter"
    },
    "includedFrameTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "CONTROL",
          "DATA",
          "MANAGEMENT"
        ]
      },
      "description": "Frame type filter"
    },
    "captureMode": {
      "type": "string",
      "enum": [
        "STREAMING",
        "FILE_CAPTURE"
      ],
      "description": "Capture mode"
    },
    "captureState": {
      "type": "string",
      "description": "Capture state"
    }
  }
}

AP packet capture startFileCapture

POST/v11_1/aps/{apMac}/apPacketCapture/startFileCapture

Use this API to start AP packet capture

Request
HideShow
Body
{
  "captureInterface": "RADIO50",
  "hostIp": "192.168.1.1",
  "includedMac": "1A:2B:3C:4D:5E:6F",
  "includedFrameTypes": [
    "CONTROL",
    "DATA"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "captureInterface": {
      "type": "string",
      "enum": [
        "RADIO24",
        "RADIO50",
        "RADIO60",
        "ETH0",
        "ETH1",
        "ETH2",
        "ETH3",
        "ETH4",
        "ETH5",
        "ETH6",
        "ETH7"
      ],
      "description": "Capture interface"
    },
    "hostIp": {
      "type": "string",
      "description": "Wireshark host IP"
    },
    "includedMac": {
      "type": "string",
      "description": "MAC filter"
    },
    "includedFrameTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "CONTROL",
          "DATA",
          "MANAGEMENT"
        ]
      },
      "description": "Frame type filter"
    }
  },
  "required": [
    "captureInterface"
  ]
}
Response  200
HideShow
Body
{
  "apMac": "A1:B2:C3:D4:E5:F6",
  "captureInterface": "ETH0",
  "hostIp": "192.168.1.1",
  "includedMac": "1A:2B:3C:4D:5E:6F",
  "includedFrameTypes": [
    "MANAGEMENT"
  ],
  "captureMode": "STREAMING",
  "captureState": "Streaming"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apMac": {
      "type": "string",
      "description": "AP MAC address"
    },
    "captureInterface": {
      "type": "string",
      "enum": [
        "RADIO24",
        "RADIO50",
        "ETH0",
        "ETH1",
        "ETH2",
        "ETH3",
        "ETH4",
        "ETH5",
        "ETH6",
        "ETH7"
      ],
      "description": "Capture interface"
    },
    "hostIp": {
      "type": "string",
      "description": "Wireshark host IP"
    },
    "includedMac": {
      "type": "string",
      "description": "MAC filter"
    },
    "includedFrameTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "CONTROL",
          "DATA",
          "MANAGEMENT"
        ]
      },
      "description": "Frame type filter"
    },
    "captureMode": {
      "type": "string",
      "enum": [
        "STREAMING",
        "FILE_CAPTURE"
      ],
      "description": "Capture mode"
    },
    "captureState": {
      "type": "string",
      "description": "Capture state"
    }
  }
}

AP packet capture download

POST/v11_1/aps/{apMac}/apPacketCapture/download

Use this API to download AP packet capture file

Response  200
HideShow
Headers
Content-Type: application/octet-stream

AP packet capture stop

POST/v11_1/aps/{apMac}/apPacketCapture/stop

Use this API to stop AP packet capture or streaming

Response  200

Query Mesh Topology by AP MAC

POST/v11_1/query/mesh/{apMac}/topology

Use this API command to retrieve a list of topology on mesh AP. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
[
  {
    "apMac": "AB:CD:00:00:00:0D",
    "meshRole": "eMesh AP",
    "apName": "AP014",
    "apModel": "R500",
    "ipAddress": "192.168.0.162",
    "externalIPAddress": "10.10.10.33:3000",
    "channel": null,
    "uplinkRssi": 77,
    "downlinkRssi": null,
    "hasDownLink": false,
    "clientCount": 0,
    "hops": 0,
    "uplinkMCSRate": 50,
    "downlinkMCSRate": null
  }
]
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "apMac": {
        "description": "The MAC of the mesh AP",
        "type": "string"
      },
      "meshRole": {
        "description": "The Role of the mesh AP",
        "type": "string"
      },
      "apName": {
        "description": "The name of the mesh AP",
        "type": "string"
      },
      "apModel": {
        "description": "The model of the mesh AP",
        "type": "string"
      },
      "ipAddress": {
        "description": "The IP of the mesh AP",
        "type": "integer"
      },
      "externalIPAddress": {
        "description": "The external IP of the mesh AP",
        "type": "string"
      },
      "channel": {
        "description": "The channel of the mesh AP",
        "type": "string"
      },
      "uplinkChannel": {
        "description": "The uplink channel of the mesh AP",
        "type": "string"
      },
      "downlinkChannel": {
        "description": "The downlink channel of the mesh AP",
        "type": "string"
      },
      "uplinkSnr": {
        "description": "The uplink SNR of the mesh AP",
        "type": "integer"
      },
      "downlinkSnr": {
        "description": "The downlink SNR of the mesh AP",
        "type": "integer"
      },
      "hasDownLink": {
        "description": "The hasDownLink of the mesh AP",
        "type": "boolean"
      },
      "clientCount": {
        "description": "The count of clients of the mesh AP",
        "type": "integer"
      },
      "hops": {
        "description": "The hop count of this mesh AP",
        "type": "integer"
      },
      "helperZoneInfo": {
        "type": "array",
        "items": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "helperAPZoneId": {
              "type": "string"
            },
            "helperAPZoneName": {
              "type": "string"
            }
          }
        }
      },
      "uplinkMCSRate": {
        "description": "The uplink MCS Rate of the mesh AP",
        "type": "integer"
      },
      "downlinkMCSRate": {
        "description": "The downlink MCS Rate of the mesh AP",
        "type": "integer"
      }
    }
  }
}

Query Mesh Neighbor AP List

POST/v11_1/query/mesh/{apMac}/neighbor

Use this API command to retrieve a list of neighbor access points on mesh AP. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "rawDataTotalCount": 100,
  "totalCount": 10,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "apMac": "AB:CD:00:00:00:02",
      "apName": "AP003",
      "ipAddress": "192.168.0.234",
      "externalIPAddress": "10.10.10.1:2000",
      "apModel": "R500",
      "apFirmware": "3.5.0.102.79",
      "channel": "108(a/g)",
      "connectionStatus": "Disconnect",
      "rssi": 56
    }
  ],
  "extra": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "rawDataTotalCount": {
      "description": "MeshNeighborInfos count.",
      "type": "integer"
    },
    "totalCount": {
      "description": "MeshNeighborInfos count in this response.",
      "type": "integer"
    },
    "extra": {
      "description": "Any additional response data.",
      "type": "object"
    },
    "hasMore": {
      "description": "Indicator of whether there are more MeshNeighborInfo after the current displayed list",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first MeshNeighborInfo returned out of the complete Rogue AP list",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "apMac": {
            "description": "The MAC of the neighbor AP",
            "type": "string"
          },
          "apName": {
            "description": "The name of the neighbor AP",
            "type": "string"
          },
          "ipAddress": {
            "description": "The IP of the neighbor AP",
            "type": "string"
          },
          "externalIPAddress": {
            "description": "The external IP of the neighbor AP",
            "type": "string"
          },
          "apModel": {
            "description": "The model of the neighbor AP",
            "type": "string"
          },
          "apFirmware": {
            "description": "The firmware of the neighbor AP",
            "type": "string"
          },
          "channel": {
            "description": "The channel of the neighbor AP",
            "type": "string"
          },
          "connectionStatus": {
            "description": "The connection status of the neighbor AP",
            "type": "string"
          },
          "snr": {
            "description": "The SNR of the neighbor AP",
            "type": "integer"
          },
          "zoneName": {
            "description": "The zone name of the neighbor AP",
            "type": "string"
          }
        }
      }
    }
  }
}

Query Mesh Topology

POST/v11_1/query/mesh/topology

Use this API command to retrieve a list of topology on zone. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "rawDataTotalCount": 100,
  "totalCount": 10,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "apMac": "AB:CD:00:00:00:0D",
      "meshRole": "eMesh AP",
      "apName": "AP014",
      "apModel": "R500",
      "ipAddress": "192.168.0.162",
      "externalIPAddress": "10.10.10.33:3000",
      "channel": null,
      "uplinkRssi": 77,
      "downlinkRssi": null,
      "hasDownLink": false,
      "clientCount": 0,
      "hops": 0,
      "uplinkMCSRate": 50,
      "downlinkMCSRate": null
    }
  ],
  "extra": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "rawDataTotalCount": {
      "description": "MeshNodeInfos count.",
      "type": "integer"
    },
    "totalCount": {
      "description": "MeshNodeInfos count in this response.",
      "type": "integer"
    },
    "extra": {
      "description": "Any additional response data.",
      "type": "object"
    },
    "hasMore": {
      "description": "Indicator of whether there are more MeshNodeInfo after the current displayed list",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first MeshNodeInfo returned out of the complete Rogue AP list",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "apMac": {
            "description": "The MAC of the mesh AP",
            "type": "string"
          },
          "meshRole": {
            "description": "The Role of the mesh AP",
            "type": "string"
          },
          "apName": {
            "description": "The name of the mesh AP",
            "type": "string"
          },
          "apModel": {
            "description": "The model of the mesh AP",
            "type": "string"
          },
          "ipAddress": {
            "description": "The IP of the mesh AP",
            "type": "integer"
          },
          "externalIPAddress": {
            "description": "The external IP of the mesh AP",
            "type": "string"
          },
          "channel": {
            "description": "The channel of the mesh AP",
            "type": "string"
          },
          "uplinkChannel": {
            "description": "The uplink channel of the mesh AP",
            "type": "string"
          },
          "downlinkChannel": {
            "description": "The downlink channel of the mesh AP",
            "type": "string"
          },
          "uplinkSnr": {
            "description": "The uplink SNR of the mesh AP",
            "type": "integer"
          },
          "downlinkSnr": {
            "description": "The downlink SNR of the mesh AP",
            "type": "integer"
          },
          "hasDownLink": {
            "description": "The hasDownLink of the mesh AP",
            "type": "boolean"
          },
          "clientCount": {
            "description": "The count of clients of the mesh AP",
            "type": "integer"
          },
          "hops": {
            "description": "The hop count of this mesh AP",
            "type": "integer"
          },
          "helperZoneInfo": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "helperAPZoneId": {
                  "type": "string"
                },
                "helperAPZoneName": {
                  "type": "string"
                }
              }
            }
          },
          "uplinkMCSRate": {
            "description": "The uplink MCS Rate of the mesh AP",
            "type": "integer"
          },
          "downlinkMCSRate": {
            "description": "The downlink MCS Rate of the mesh AP",
            "type": "integer"
          }
        }
      }
    }
  }
}

Query Rogue AP List

POST/v11_1/query/roguesInfoList

Use this API command to retrieve a list of rogue access points. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "rawDataTotalCount": 100,
  "totalCount": 10,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "detectedByAP": [
        {
          "apMac": "FF:FF:FF:FF:FF:FF",
          "apName": "Dummy AP",
          "rssi": "64",
          "rogueType": "Rogue",
          "lastDetected": 1470717826622,
          "zoneName": "Zone1",
          "mainDetector": true
        }
      ],
      "channel": 11,
      "rogueMac": "DD:DD:DD:DD:DD:DD",
      "encryption": "WPA",
      "radio": "54",
      "lastDetected": 1470717826622,
      "ssid": "Dummy SSID",
      "type": "AD_HOC",
      "rogueAPMac": "EE:EE:EE:EE:EE:EE"
    },
    {
      "detectedByAP": [
        {
          "apMac": "FF:FF:FF:FF:FF:FF",
          "apName": "Dummy AP",
          "rssi": "64",
          "lastDetected": 1470717826622
        }
      ],
      "channel": 11,
      "rogueMac": "DD:DD:DD:DD:DD:DD",
      "encryption": "WPA",
      "radio": "54",
      "lastDetected": 1470717826622,
      "ssid": "Dummy SSID",
      "type": "AD_HOC",
      "rogueAPMac": "EE:EE:EE:EE:EE:EE"
    }
  ],
  "extra": null
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "rawDataTotalCount" : {
            "description" : "Total Rogue APs count.",
            "type" : "integer"
        },
        "totalCount" : {
            "description" : "Total Rogue APs count in this response.",
            "type" : "integer"
        },
        "extra" : {
            "description" : "Any additional response data.",
            "type" : "object"
        },
        "hasMore" : {
            "description" : "Indicator of whether there are more Rogue AP after the current displayed list",
            "type" : "boolean"
        },
        "firstIndex" : {
            "description" : "Index of the first Rogue AP returned out of the complete Rogue AP list",
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "detectedByAP" : {
                        "description" : "The list of the AP found this Rogue AP.",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "apMac" : {
                                    "description" : "AP MAC of the rogue AP",
                                    "type" : "string",
                                    "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                                },
                                "apName" : {
                                    "description" : "Name of the rogue AP",
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 64,
                                    "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
                                },
                                "rssi" : {
                                    "description" : "RSSI of the rogue AP",
                                    "type" : "string"
                                },
                                "lastDetected" : {
                                    "description" : "Timestamp of the AP",
                                    "type" : "integer"
                                },
                                "zoneName" : {
                                    "description" : "Zone name",
                                    "type" : "string"
                                },
                                "rogueType" : {
                                    "description" : "Rogue type",
                                    "type" : "string"
                                },
                                "mainDetector" : {
                                    "description" : "To identify whether this is main instance for UI",
                                    "type" : "boolean"
                                }
                            }
                        }
                    },
                    "channel" : {
                        "description" : "Channel of the rogue AP",
                        "type" : "integer"
                    },
                    "rogueMac" : {
                        "description" : "Rogue MAC of the rogue AP",
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                    },
                    "encryption" : {
                        "description" : "Encryption of the rogue AP",
                        "type" : "string"
                    },
                    "radio" : {
                        "description" : "Radio of the rogue AP",
                        "type" : "string"
                    },
                    "lastDetected" : {
                        "description" : "Timestamp of the rogue AP",
                        "type" : "integer",
                        "format" : "int64"
                    },
                    "ssid" : {
                        "description" : "SSID of the rogue AP",
                        "type" : "string"
                    },
                    "type" : {
                        "description" : "Type of the rogue AP",
                        "type" : "string"
                    },
                    "rogueAPMac" : {
                        "description" : "Rogue AP MAC of the rogue AP",
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                    },
                    "classification" : {
                        "description" : "Rogue classification by policy",
                        "type" : "string"
                    },
                    "matchResult" : {
                        "description" : "What policy and rule matched when system doing classification by rogue policy",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

Retrieve AP Wlan list with BSSID information by QueryCriteria

POST/v11_1/query/ap/wlan

Use this API command to retrieve AP Wlan list with BSSID information by QueryCriteria Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "rawDataTotalCount": 1,
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "apMac": "38:FF:36:12:F1:90",
      "deviceName": "RuckusAP",
      "wlanBssids": [
        {
          "wlanName": "wlanA",
          "bssid": "38:FF:36:12:F1:98",
          "wlanId": 1,
          "radioId": 0
        },
        {
          "wlanName": "wlanB",
          "bssid": "38:FF:36:52:F1:98",
          "wlanId": 2,
          "radioId": 0
        },
        {
          "wlanName": "wlanC",
          "bssid": "38:FF:36:92:F1:98",
          "wlanId": 3,
          "radioId": 0
        },
        {
          "wlanName": "wlanD",
          "bssid": "38:FF:36:D2:F1:98",
          "wlanId": 4,
          "radioId": 0
        },
        {
          "wlanName": "wlanE",
          "bssid": "38:FF:36:12:F1:99",
          "wlanId": 5,
          "radioId": 0
        },
        {
          "wlanName": "wlanF",
          "bssid": "38:FF:36:52:F1:99",
          "wlanId": 6,
          "radioId": 0
        },
        {
          "wlanName": "wlanG",
          "bssid": "38:FF:36:92:F1:99",
          "wlanId": 7,
          "radioId": 0
        },
        {
          "wlanName": "wlanA",
          "bssid": "38:FF:36:12:F1:9C",
          "wlanId": 1,
          "radioId": 1
        },
        {
          "wlanName": "wlanB",
          "bssid": "38:FF:36:52:F1:9C",
          "wlanId": 2,
          "radioId": 1
        },
        {
          "wlanName": "wlanC",
          "bssid": "38:FF:36:92:F1:9C",
          "wlanId": 3,
          "radioId": 1
        },
        {
          "wlanName": "wlanD",
          "bssid": "38:FF:36:D2:F1:9C",
          "wlanId": 4,
          "radioId": 1
        },
        {
          "wlanName": "wlanE",
          "bssid": "38:FF:36:12:F1:9D",
          "wlanId": 5,
          "radioId": 1
        },
        {
          "wlanName": "wlanF",
          "bssid": "38:FF:36:52:F1:9D",
          "wlanId": 6,
          "radioId": 1
        },
        {
          "wlanName": "wlanG",
          "bssid": "38:FF:36:92:F1:9D",
          "wlanId": 7,
          "radioId": 1
        }
      ]
    }
  ],
  "extra": null
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "description": "Index of first index in current page",
      "type": "integer"
    },
    "hasMore": {
      "description": "Has more data or not",
      "type": "boolean"
    },
    "totalCount": {
      "description": "Total matched AP count",
      "type": "integer"
    },
    "extra": {
      "description": "extra information",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "apMac": {
            "type": "string"
          },
          "deviceName": {
            "type": "string"
          },
          "wlanBssids": {
            "type": "array",
            "items": {
              "additionalProperties": false,
              "type": "object",
              "properties": {
                "wlanName": {
                  "type": "string"
                },
                "bssid": {
                  "type": "string"
                },
                "wlanId": {
                  "type": "integer"
                },
                "radioId": {
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    }
  }
}

Query APs

POST/v11_1/query/ap

Query APs with specified filters Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DOMAIN",
              "ZONE",
              "APGROUP",
              "AP",
              "INDOORMAP",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DATABLADEIPADDRESS",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DATABLADEIPADDRESS",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "specified feature required informaion",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 9,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "deviceName": "AP001",
      "description": "Description",
      "status": "Online",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "airtime6G": null,
      "latency24G": null,
      "latency50G": null,
      "latency6G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "capacity6G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:00",
      "channel24G": null,
      "channel5G": null,
      "channel6G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": "10.10.10.33",
      "extPort": "4000",
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "retry6G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "numClients6G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup6gId": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "wlanGroup6gName": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": "ProvisionMethod1",
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720659798,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": "66479bc8-44c7-4f6b-b741-d4056b0305a7",
      "apGroupId": "c9e43dad-cbcb-4f75-a804-2680ea4c0e80",
      "indoorMapXy": {
        "x": 368.4700012207031,
        "y": 108.5
      },
      "indoorMapName": "DemoMap",
      "indoorMapLocation": "350 W Java Dr Sunnyvale, CA 94089",
      "deviceGps": null,
      "connectionStatus": "Connect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isLatency6GFlagged": false,
      "isCapacity6GFlagged": false,
      "isConnectionFailure6GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "isAirtimeUtilization6GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "eirp6G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP002",
      "description": "Description",
      "status": "Online",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "airtime6G": null,
      "latency24G": null,
      "latency50G": null,
      "latency6G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "capacity6G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:01",
      "channel24G": null,
      "channel5G": null,
      "channel6G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": "10.10.10.22",
      "extPort": "2000",
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "retry6G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "numClients6G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup6gId": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "wlanGroup6gName": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": "ProvisionMethod2",
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720660065,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": "66479bc8-44c7-4f6b-b741-d4056b0305a7",
      "apGroupId": "c9e43dad-cbcb-4f75-a804-2680ea4c0e80",
      "indoorMapXy": {
        "x": 651.5499877929688,
        "y": 273.9100036621094
      },
      "indoorMapName": "DemoMap",
      "indoorMapLocation": "350 W Java Dr Sunnyvale, CA 94089",
      "deviceGps": null,
      "connectionStatus": "Connect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isLatency6GFlagged": false,
      "isCapacity6GFlagged": false,
      "isConnectionFailure6GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "isAirtimeUtilization6GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "eirp6G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP005",
      "description": "Description",
      "status": "Offline",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "airtime6G": null,
      "latency24G": null,
      "latency50G": null,
      "latency6G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "capacity6G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:04",
      "channel24G": null,
      "channel5G": null,
      "channel6G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": "10.10.10.1",
      "extPort": "4000",
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "retry6G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "numClients6G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup6gId": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "wlanGroup6gName": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": "ProvisionMethod1",
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720660327,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": null,
      "apGroupId": "2d01323d-6224-4de5-995b-e3311c767a74",
      "indoorMapXy": null,
      "indoorMapName": null,
      "indoorMapLocation": null,
      "deviceGps": null,
      "connectionStatus": "Disconnect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isLatency6GFlagged": false,
      "isCapacity6GFlagged": false,
      "isConnectionFailure6GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "isAirtimeUtilization6GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "eirp6G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP006",
      "description": "Description",
      "status": "Offline",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "airtime6G": null,
      "latency24G": null,
      "latency50G": null,
      "latency6G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "capacity6G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:05",
      "channel24G": null,
      "channel5G": null,
      "channel6G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": "10.10.10.22",
      "extPort": "3000",
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "retry6G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "numClients6G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup6gId": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "wlanGroup6gName": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": "ProvisionMethod1",
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720660388,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": null,
      "apGroupId": "2d01323d-6224-4de5-995b-e3311c767a74",
      "indoorMapXy": null,
      "indoorMapName": null,
      "indoorMapLocation": null,
      "deviceGps": null,
      "connectionStatus": "Disconnect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isLatency6GFlagged": false,
      "isCapacity6GFlagged": false,
      "isConnectionFailure6GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "isAirtimeUtilization6GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "eirp6G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP007",
      "description": "Description",
      "status": "Online",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "airtime6G": null,
      "latency24G": null,
      "latency50G": null,
      "latency6G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "capacity6G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:06",
      "channel24G": null,
      "channel5G": null,
      "channel6G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": "10.10.10.1",
      "extPort": "3000",
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "retry6G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "numClients6G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup6gId": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "wlanGroup6gName": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": "ProvisionMethod1",
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720660452,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": null,
      "apGroupId": "4db7c545-4b1d-49f1-857e-8b271ae9af42",
      "indoorMapXy": null,
      "indoorMapName": null,
      "indoorMapLocation": null,
      "deviceGps": null,
      "connectionStatus": "Connect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isLatency6GFlagged": false,
      "isCapacity6GFlagged": false,
      "isConnectionFailure6GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "isAirtimeUtilization6GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "eirp6G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP008",
      "description": "Description",
      "status": "Online",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "airtime6G": null,
      "latency24G": null,
      "latency50G": null,
      "latency6G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "capacity6G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:07",
      "channel24G": null,
      "channel5G": null,
      "channel6G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": "10.10.10.22",
      "extPort": "3000",
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "retry6G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "numClients6G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup6gId": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "wlanGroup6gName": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": "ProvisionMethod2",
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720660514,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": null,
      "apGroupId": "4db7c545-4b1d-49f1-857e-8b271ae9af42",
      "indoorMapXy": null,
      "indoorMapName": null,
      "indoorMapLocation": null,
      "deviceGps": null,
      "connectionStatus": "Connect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isLatency6GFlagged": false,
      "isCapacity6GFlagged": false,
      "isConnectionFailure6GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "isAirtimeUtilization6GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "eirp6G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP009",
      "description": "Description",
      "status": "Online",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "airtime6G": null,
      "latency24G": null,
      "latency50G": null,
      "latency6G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "capacity6G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:08",
      "channel24G": null,
      "channel5G": null,
      "channel6G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": "10.10.10.1",
      "extPort": "2000",
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "retry6G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "numClients6G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup6gId": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "wlanGroup6gName": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": "ProvisionMethod2",
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720660583,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": null,
      "apGroupId": "4db7c545-4b1d-49f1-857e-8b271ae9af42",
      "indoorMapXy": null,
      "indoorMapName": null,
      "indoorMapLocation": null,
      "deviceGps": null,
      "connectionStatus": "Connect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isLatency6GFlagged": false,
      "isCapacity6GFlagged": false,
      "isConnectionFailure6GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "isAirtimeUtilization6GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "eirp6G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP054",
      "description": "iYip7ido",
      "status": "Online",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "airtime6G": null,
      "latency24G": null,
      "latency50G": null,
      "latency6G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "capacity6G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:35",
      "channel24G": null,
      "channel5G": null,
      "channel6G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": null,
      "extPort": null,
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "retry6G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "numClients6G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup6gId": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "wlanGroup6gName": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": null,
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720663315,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": null,
      "apGroupId": "df9a60ae-a69a-4a3f-a5b5-fa2657ae8494",
      "indoorMapXy": null,
      "indoorMapName": null,
      "indoorMapLocation": null,
      "deviceGps": null,
      "connectionStatus": "Connect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isLatency6GFlagged": false,
      "isCapacity6GFlagged": false,
      "isConnectionFailure6GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "isAirtimeUtilization6GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "eirp6G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP055",
      "description": "llEtjoXe",
      "status": "Online",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "airtime6G": null,
      "latency24G": null,
      "latency50G": null,
      "latency6G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "capacity6G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:36",
      "channel24G": null,
      "channel5G": null,
      "channel6G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": null,
      "extPort": null,
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "retry6G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "numClients6G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup6gId": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "wlanGroup6gName": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": null,
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720663357,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": null,
      "apGroupId": "df9a60ae-a69a-4a3f-a5b5-fa2657ae8494",
      "indoorMapXy": null,
      "indoorMapName": null,
      "indoorMapLocation": null,
      "deviceGps": null,
      "connectionStatus": "Connect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isLatency6GFlagged": false,
      "isCapacity6GFlagged": false,
      "isConnectionFailure6GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "isAirtimeUtilization6GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "eirp6G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4",
      "cellularWanInterface": "wwan0",
      "cellularConnectionStatus": "4G",
      "cellularSignalStrength": "-59 dBm",
      "cellularIMSISIM0": 310260142336966,
      "cellularIMSISIM1": 310460142336964,
      "cellularICCIDSIM0": 8901260145723369000,
      "cellularICCIDSIM1": 4501550134727369000,
      "cellularIsSIM0Present": "YES",
      "cellularIsSIM1Present": "YES",
      "cellularTxBytesSIM0": 1423446,
      "cellularTxBytesSIM1": 1356763,
      "cellularRxBytesSIM0": 1356722,
      "cellularRxBytesSIM1": 1758743,
      "cellularActiveSim": "SIM1",
      "cellularIPaddress": "1.1.1.1",
      "cellularSubnetMask": "255.255.255.0",
      "cellularDefaultGateway": "100.255.62.125",
      "cellularOperator": "T-Mobile",
      "cellular3G4GChannel": 2300,
      "cellularCountry": "US",
      "cellularRadioUptime": 1345234,
      "cellularGpsHistory": [
        {
          "timestamp": 1539851273,
          "latitude": 25.07757,
          "longitude": 121.570908
        },
        {
          "timestamp": 1539851293,
          "latitude": 25.07757,
          "longitude": 121.570908
        }
      ]
    }
  ],
  "extra": {
    "rbacMetadata": [
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      }
    ]
  }
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "totalCount": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for AP list",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "registrationTime": {
            "type": "integer",
            "format": "int64"
          },
          "poePortStatus": {
            "type": "string"
          },
          "indoorMapId": {
            "type": "string"
          },
          "channel24G": {
            "type": "string"
          },
          "channel24gValue": {
            "type": "integer",
            "format": "int64"
          },
          "configOverride": {
            "type": "boolean"
          },
          "deviceName": {
            "type": "string"
          },
          "enabledBonjourGateway": {
            "type": "boolean"
          },
          "numClients24G": {
            "type": "integer",
            "format": "int64"
          },
          "dataBladeName": {
            "type": "string"
          },
          "retry24G": {
            "type": "integer",
            "format": "int64"
          },
          "airtime24G": {
            "type": "integer",
            "format": "int64"
          },
          "noise5G": {
            "type": "integer",
            "format": "int64"
          },
          "noise6G": {
            "type": "integer",
            "format": "int64"
          },
          "model": {
            "type": "string"
          },
          "numClients": {
            "type": "integer",
            "format": "int64"
          },
          "capacity24G": {
            "type": "integer"
          },
          "firmwareVersion": {
            "type": "string"
          },
          "provisionMethod": {
            "type": "string"
          },
          "latency24G": {
            "type": "integer",
            "format": "int64"
          },
          "retry5G": {
            "type": "integer",
            "format": "int64"
          },
          "retry6G": {
            "type": "integer",
            "format": "int64"
          },
          "ip": {
            "type": "string"
          },
          "apMac": {
            "type": "string"
          },
          "noise24G": {
            "type": "integer",
            "format": "int64"
          },
          "lastSeen": {
            "type": "integer",
            "format": "int64"
          },
          "configurationStatus": {
            "type": "string"
          },
          "airtime5G": {
            "type": "integer",
            "format": "int64"
          },
          "airtime6G": {
            "type": "integer",
            "format": "int64"
          },
          "alerts": {
            "type": "integer",
            "format": "int64"
          },
          "lbsStatus": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "Online",
              "Offline",
              "Flagged"
            ]
          },
          "numClients5G": {
            "type": "integer",
            "format": "int64"
          },
          "numClients6G": {
            "type": "integer",
            "format": "int64"
          },
          "ipv6Address": {
            "type": "string"
          },
          "capacity50G": {
            "type": "integer"
          },
          "capacity6G": {
            "type": "integer"
          },
          "wlanGroup24Name": {
            "type": "string"
          },
          "connectionFailure": {
            "type": "number"
          },
          "description": {
            "type": "string"
          },
          "capacity": {
            "type": "integer"
          },
          "meshRole": {
            "type": "string"
          },
          "channel5G": {
            "type": "string"
          },
          "channel50gValue": {
            "type": "integer",
            "format": "int64"
          },
          "channel6G": {
            "type": "string"
          },
          "channel6gValue": {
            "type": "integer",
            "format": "int64"
          },
          "managementVlan": {
            "type": "integer"
          },
          "wlanGroup6gName": {
            "type": "string"
          },
          "wlanGroup50Name": {
            "type": "string"
          },
          "wlanGroup24Id": {
            "type": "string"
          },
          "controlBladeName": {
            "type": "string"
          },
          "zoneName": {
            "type": "string"
          },
          "tx": {
            "description": "The total data size transmitted in a period of time",
            "type": "integer",
            "format": "int64"
          },
          "rx": {
            "description": "The total data size received in a period of time",
            "type": "integer",
            "format": "int64"
          },
          "txRx": {
            "description": "The total data size transmitted and received in a period of time",
            "type": "integer",
            "format": "int64"
          },
          "tx24G": {
            "description": "The total data size transmitted in a period of time",
            "type": "integer",
            "format": "int64"
          },
          "tx50G": {
            "description": "The total data size transmitted in a period of time",
            "type": "integer",
            "format": "int64"
          },
          "tx6G": {
            "type": "integer",
            "format": "int64"
          },
          "rx24G": {
            "description": "The total data size received in a period of time",
            "type": "integer",
            "format": "int64"
          },
          "rx50G": {
            "description": "The total data size received in a period of time",
            "type": "integer",
            "format": "int64"
          },
          "rx6G": {
            "type": "integer",
            "format": "int64"
          },
          "txRx24G": {
            "description": "The total data size transmitted and received in a period of time",
            "type": "integer",
            "format": "int64"
          },
          "txRx50G": {
            "description": "The total data size transmitted and received in a period of time",
            "type": "integer",
            "format": "int64"
          },
          "txRx6G": {
            "type": "integer",
            "format": "int64"
          },
          "meshMode": {
            "type": "string"
          },
          "extPort": {
            "type": "string"
          },
          "administrativeState": {
            "type": "string"
          },
          "apGroupName": {
            "type": "string"
          },
          "latency50G": {
            "type": "integer",
            "format": "int64"
          },
          "latency6G": {
            "type": "integer",
            "format": "int64"
          },
          "indoorMapXy": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "x": {
                "type": "number"
              },
              "y": {
                "type": "number"
              }
            }
          },
          "apGroupId": {
            "type": "string"
          },
          "extIp": {
            "type": "string"
          },
          "airtime": {
            "type": "integer"
          },
          "provisionStage": {
            "type": "string"
          },
          "indoorMapName": {
            "type": "string"
          },
          "indoorMapLocation": {
            "type": "string"
          },
          "deviceGps": {
            "type": "string"
          },
          "serial": {
            "type": "string"
          },
          "location": {
            "type": "string"
          },
          "wlanGroup50Id": {
            "type": "string"
          },
          "wlanGroup6gId": {
            "type": "string"
          },
          "registrationState": {
            "type": "string"
          },
          "zoneId": {
            "type": "string"
          },
          "zoneFirmwareVersion": {
            "type": "string"
          },
          "zoneAffinityProfileName": {
            "type": "string"
          },
          "connectionStatus": {
            "type": "string"
          },
          "domainId": {
            "type": "string"
          },
          "domainName": {
            "type": "string"
          },
          "partnerDomainId": {
            "type": "string"
          },
          "dpIp": {
            "type": "string"
          },
          "controlBladeId": {
            "type": "string"
          },
          "isCriticalAp": {
            "type": "boolean"
          },
          "crashDump": {
            "type": "integer"
          },
          "cableModemSupported": {
            "type": "boolean"
          },
          "cableModemResetSupported": {
            "type": "boolean"
          },
          "swapInMac": {
            "type": "string"
          },
          "swapOutMac": {
            "type": "string"
          },
          "packetCaptureState": {
            "type": "string"
          },
          "isOverallHealthStatusFlagged": {
            "type": "boolean"
          },
          "isLatency24GFlagged": {
            "type": "boolean"
          },
          "isCapacity24GFlagged": {
            "type": "boolean"
          },
          "isConnectionFailure24GFlagged": {
            "type": "boolean"
          },
          "isLatency50GFlagged": {
            "type": "boolean"
          },
          "isCapacity50GFlagged": {
            "type": "boolean"
          },
          "isConnectionFailure50GFlagged": {
            "type": "boolean"
          },
          "isLatency6GFlagged": {
            "type": "boolean"
          },
          "isCapacity6GFlagged": {
            "type": "boolean"
          },
          "isConnectionFailure6GFlagged": {
            "type": "boolean"
          },
          "isConnectionTotalCountFlagged": {
            "type": "boolean"
          },
          "isConnectionFailureFlagged": {
            "type": "boolean"
          },
          "isAirtimeUtilization24GFlagged": {
            "type": "boolean"
          },
          "isAirtimeUtilization50GFlagged": {
            "type": "boolean"
          },
          "isAirtimeUtilization6GFlagged": {
            "type": "boolean"
          },
          "eirp24G": {
            "type": "integer"
          },
          "eirp50G": {
            "type": "integer"
          },
          "eirp6G": {
            "type": "integer"
          },
          "supportFips": {
            "type": "boolean"
          },
          "fipsEnabled": {
            "type": "boolean"
          },
          "uptime": {
            "type": "integer"
          },
          "ipsecSessionTime": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecTxPkts": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecRxPkts": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecTxBytes": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecRxBytes": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecTxDropPkts": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecRxDropPkts": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecTxIdleTime": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecRxIdleTime": {
            "type": "integer",
            "format": "int64"
          },
          "ipType": {
            "type": "string"
          },
          "ipv6Type": {
            "type": "string"
          },
          "cellularWanInterface": {
            "type": "string"
          },
          "cellularConnectionStatus": {
            "type": "string"
          },
          "cellularSignalStrength": {
            "type": "string"
          },
          "cellularIMSISIM0": {
            "type": "string"
          },
          "cellularIMSISIM1": {
            "type": "string"
          },
          "cellularICCIDSIM0": {
            "type": "string"
          },
          "cellularICCIDSIM1": {
            "type": "string"
          },
          "cellularIsSIM0Present": {
            "type": "string"
          },
          "cellularIsSIM1Present": {
            "type": "string"
          },
          "cellularTxBytesSIM0": {
            "type": "integer",
            "format": "int64"
          },
          "cellularTxBytesSIM1": {
            "type": "integer",
            "format": "int64"
          },
          "cellularRxBytesSIM0": {
            "type": "integer",
            "format": "int64"
          },
          "cellularRxBytesSIM1": {
            "type": "integer",
            "format": "int64"
          },
          "cellularActiveSim": {
            "type": "string"
          },
          "cellularIPaddress": {
            "type": "string"
          },
          "cellularSubnetMask": {
            "type": "string"
          },
          "cellularDefaultGateway": {
            "type": "string"
          },
          "cellularOperator": {
            "type": "string"
          },
          "cellular3G4GChannel": {
            "type": "integer"
          },
          "cellularCountry": {
            "type": "string"
          },
          "cellularRadioUptime": {
            "type": "integer"
          },
          "cellularGpsHistory": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "timestamp": {
                  "type": "integer"
                },
                "latitude": {
                  "type": "string"
                },
                "longitude": {
                  "type": "string"
                }
              }
            }
          },
          "medianTxRadioMCSRate24G": {
            "type": "integer",
            "format": "int64"
          },
          "medianTxRadioMCSRate50G": {
            "type": "integer",
            "format": "int64"
          },
          "medianTxRadioMCSRate6G": {
            "type": "integer",
            "format": "int64"
          },
          "medianRxRadioMCSRate24G": {
            "type": "integer",
            "format": "int64"
          },
          "medianRxRadioMCSRate50G": {
            "type": "integer",
            "format": "int64"
          },
          "medianRxRadioMCSRate6G": {
            "type": "integer",
            "format": "int64"
          },
          "monitoringEnabled": {
            "type": "boolean"
          },
          "txPowerOffset24G": {
            "type": "integer"
          },
          "txPowerOffset5G": {
            "type": "integer"
          },
          "txPowerOffset6G": {
            "type": "integer"
          },
          "rxDesense24G": {
            "type": "integer"
          },
          "rxDesense5G": {
            "type": "integer"
          },
          "rxDesense6G": {
            "type": "integer"
          },
          "cumulativeTx24G": {
            "type": "integer",
            "format": "int64"
          },
          "cumulativeRx24G": {
            "type": "integer",
            "format": "int64"
          },
          "cumulativeTxRx24G": {
            "type": "integer",
            "format": "int64"
          },
          "cumulativeTx5G": {
            "type": "integer",
            "format": "int64"
          },
          "cumulativeRx5G": {
            "type": "integer",
            "format": "int64"
          },
          "cumulativeTxRx5G": {
            "type": "integer",
            "format": "int64"
          },
          "cumulativeTx6G": {
            "type": "integer",
            "format": "int64"
          },
          "cumulativeRx6G": {
            "type": "integer",
            "format": "int64"
          },
          "cumulativeTxRx6G": {
            "type": "integer",
            "format": "int64"
          },
          "isDual5gMode": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Retrieve indoorMap List

POST/v11_1/query/indoorMap

Query indoorMap with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 3,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "name": "testMap",
      "description": "",
      "imageFileName": "^B7DD96DBDEDD273F0AE10E2BC49F394D6F6A972EA001F73854^pimgptestMap.png",
      "address": "apg1map",
      "longitude": 121.56999969482422,
      "latitude": 25.06999969482422,
      "apGroupId": "0f7acc6c-1777-4c05-8b9c-2f88df5bad4b",
      "zoneId": "c8fb596b-a87c-4d97-a18c-df21d5bae631",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "groupType": "APGROUP",
      "scale": {
        "a": {
          "x": 411,
          "y": 187.390625
        },
        "b": {
          "x": 356,
          "y": 189.390625
        },
        "distance": 11,
        "unit": "MM"
      },
      "apCount": 0
    }
  ],
  "extra": {
    "rbacMetadata": [
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      }
    ]
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total indoor maps count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more indoor maps after the list that is currently displayed",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first indoorMapList returned out of the complete indoor maps list",
      "type": "integer"
    },
    "extra": {
      "description": "extra information for indoor map",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "id",
            "type": "string"
          },
          "key": {
            "description": "id",
            "type": "string"
          },
          "zoneId": {
            "description": "zoneId",
            "type": "string"
          },
          "apCount": {
            "description": "AP count in this indoor map",
            "type": "number"
          },
          "name": {
            "description": "name",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "description",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "address": {
            "description": "address",
            "type": "string"
          },
          "imageFileName": {
            "description": "imageFileName",
            "type": "string"
          },
          "latitude": {
            "description": "latitude",
            "type": "number"
          },
          "longitude": {
            "description": "longitude",
            "type": "number"
          },
          "groupType": {
            "description": "group Type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP"
            ]
          },
          "domainId": {
            "description": "domainId",
            "type": "string"
          },
          "tenantId": {
            "description": "tenantId",
            "type": "string"
          },
          "scale": {
            "description": "scale",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "a": {
                "description": "point a",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "x": {
                    "description": "x",
                    "type": "number"
                  },
                  "y": {
                    "description": "y",
                    "type": "number"
                  }
                }
              },
              "b": {
                "description": "point b",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "x": {
                    "description": "x",
                    "type": "number"
                  },
                  "y": {
                    "description": "y",
                    "type": "number"
                  }
                }
              },
              "distance": {
                "description": "distance",
                "type": "number"
              },
              "unit": {
                "description": "unit",
                "type": "string",
                "enum": [
                  "MM",
                  "CM",
                  "M",
                  "Foot",
                  "Yard"
                ]
              }
            }
          },
          "apGroupId": {
            "description": "apGroupId",
            "type": "string"
          }
        },
        "required": [
          "name",
          "description",
          "groupType"
        ]
      }
    }
  }
}

WLAN Group

Retrieve List

GET/v11_1/rkszones/{zoneId}/wlangroups

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

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "wlanGroupUUID",
      "name": "wlanGroupName",
      "description": "wlanGroupDescription",
      "members": [
        {
          "id": "wlanID",
          "name": "wlanName",
          "accessVlan": 1,
          "nasId": "nasId",
          "vlanPooling": null
        }
      ]
    },
    {
      "id": "wlanGroupUUID2",
      "zoneId": "zoneUUID",
      "name": "wlanGroupName2",
      "description": "wlanGroupDescription2",
      "members": [
        {
          "id": "wlanID2",
          "name": "wlanName2",
          "accessVlan": 1,
          "nasId": "nasId",
          "vlanPooling": null
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the WLAN group",
            "type": "string"
          },
          "zoneId": {
            "description": "Identifier of the zone to which the WLAN group belongs",
            "type": "string"
          },
          "name": {
            "description": "Name of the WLAN group",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the WLAN group",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "members": {
            "description": "Members of the WLAN group",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "id": {
                  "description": "Identifier of the WLAN",
                  "type": "string"
                },
                "name": {
                  "description": "Name of the WLAN",
                  "type": "string"
                },
                "accessVlan": {
                  "description": "Access VLAN",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 4094
                },
                "vlanPooling": {
                  "description": "Vlan pooling",
                  "type": [
                    "object",
                    "null"
                  ],
                  "additionalProperties": false,
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  }
                },
                "nasId": {
                  "description": "NAS-ID",
                  "type": "string",
                  "maxLength": 63,
                  "pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
                }
              },
              "required": [
                "id"
              ]
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        },
        "required": [
          "name"
        ]
      }
    }
  }
}

Retrieve

GET/v11_1/rkszones/{zoneId}/wlangroups/{id}

Use this API command to retrieve the WLAN group.

Response  200
HideShow
Body
{
  "id": "wlanGroupUUID2",
  "zoneId": "zoneUUID",
  "name": "wlanGroupName2",
  "description": "wlanGroupDescription2",
  "members": [
    {
      "id": "wlanID2",
      "name": "wlanName2",
      "accessVlan": 1,
      "nasId": "nasId",
      "vlanPooling": null
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the WLAN group",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone to which the WLAN group belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the WLAN group",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the WLAN group",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "members": {
      "description": "Members of the WLAN group",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the WLAN",
            "type": "string"
          },
          "name": {
            "description": "Name of the WLAN",
            "type": "string"
          },
          "accessVlan": {
            "description": "Access VLAN",
            "type": "integer",
            "minimum": 1,
            "maximum": 4094
          },
          "vlanPooling": {
            "description": "Vlan pooling",
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          },
          "nasId": {
            "description": "NAS-ID",
            "type": "string",
            "maxLength": 63,
            "pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
          }
        },
        "required": [
          "id"
        ]
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  },
  "required": [
    "name"
  ]
}

Create

POST/v11_1/rkszones/{zoneId}/wlangroups

Use this API command to create a new WLAN group.

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

Add Member

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

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

Request
HideShow
Body
{
  "id": "wlanID",
  "accessVlan": 1
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the WLAN",
      "type": "string"
    },
    "name": {
      "description": "Name of the WLAN",
      "type": "string"
    },
    "accessVlan": {
      "description": "Access VLAN",
      "type": "integer",
      "minimum": 1,
      "maximum": 4094
    },
    "vlanPooling": {
      "description": "Vlan pooling",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "nasId": {
      "description": "NAS-ID",
      "type": "string",
      "maxLength": 63,
      "pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
    }
  },
  "required": [
    "id"
  ]
}
Response  201

Modify Member Entire

PUT/v11_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}

Use this API command to modify the member’s entire information of a WLAN group.

Request
HideShow
Body
{
  "accessVlan": 23,
  "nasId": "nasId",
  "vlanPooling": {
    "id": "a61997e0-699b-11e4-b9bb-08002716c79f",
    "name": "zoneVlanPooling"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "accessVlan": {
      "description": "Access VLAN",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 4094
    },
    "vlanPooling": {
      "description": "Vlan pooling",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "nasId": {
      "description": "NAS-ID",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 63,
      "pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
    }
  }
}
Response  204

Modify

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

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

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

Modify Member

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

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

Request
HideShow
Body
{
  "accessVlan": 23,
  "nasId": "nasId",
  "vlanPooling": {
    "id": "a61997e0-699b-11e4-b9bb-08002716c79f",
    "name": "zoneVlanPooling"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "accessVlan": {
      "description": "Access VLAN",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 4094
    },
    "vlanPooling": {
      "description": "Vlan pooling",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "nasId": {
      "description": "NAS-ID",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 63,
      "pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
    }
  }
}
Response  204

Delete

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

Use this API command to delete a WLAN group.

Response  204

Disable Member VLAN Override

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

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

Response  204

Disable Member NAS Override

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

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

Response  204

Remove Member

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

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

Response  204

WLAN

Retrieve List

GET/v11_1/rkszones/{zoneId}/wlans

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

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "1028",
      "mvnoId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "wlan2",
      "ssid": "wlan2"
    },
    {
      "id": "1027",
      "mvnoId": "bbbbbbbb-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "wlan1",
      "ssid": "wlan1"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the WLAN",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "zoneId": {
            "description": "Zone ID",
            "type": "string"
          },
          "name": {
            "description": "Name of the WLAN",
            "type": "string"
          },
          "ssid": {
            "description": "SSID of the WLAN",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve

GET/v11_1/rkszones/{zoneId}/wlans/{id}

Use this API command to retrieve a WLAN.

Response  200
HideShow
Body
{
  "id": "1027",
  "zoneId": "21a18b1c-e260-48c8-866c-69e66c81368e",
  "name": "wlan1",
  "ssid": "wlan1",
  "description": "",
  "type": "Standard_Open",
  "encryption": {
    "method": "None"
  },
  "macAuth": null,
  "authServiceOrProfile": null,
  "operatorRealm": null,
  "accountingServiceOrProfile": {
    "throughController": false,
    "id": "accountingServiceUUID",
    "name": "accountingServiceName",
    "interimUpdateMin": 10,
    "accountingDelayEnabled": false,
    "accountingTTGSessionEnabled": false,
    "backupAccountingId": "otherAccountingServiceUUID",
    "backupAccountingName": "otherAccountingServiceName"
  },
  "accessTunnelType": "APLBO",
  "coreTunnelProfile": null,
  "portalServiceProfile": null,
  "hotspot20Profile": null,
  "defaultUserTrafficProfile": {
    "id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
    "name": "Factory Default"
  },
  "precedenceProfileId": "ca1edc50-c839-11e6-afc9-525400da2f0d",
  "paloAltoFirewallProfileOverrided": true,
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "l2ACL": null,
  "devicePolicy": null,
  "vlan": {
    "accessVlan": null,
    "aaaVlanOverride": false,
    "vlanpooling": {
      "id": "0b8d4e50-167a-11e6-97a5-56847afe9799",
      "name": "X27s"
    }
  },
  "schedule": {
    "id": null,
    "name": null,
    "type": "AlwaysOn"
  },
  "radiusOptions": {
    "nasIdType": "WLAN_BSSID",
    "customizedNasId": null,
    "nasRequestTimeoutSec": 3,
    "nasMaxRetry": 2,
    "nasReconnectPrimaryMin": 5,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "singleSessionIdAcctEnabled": false,
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "firewallProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "firewallWlanSpecificEnabled": true,
  "firewallUplinkRateLimitingMbps": 20,
  "firewallDownlinkRateLimitingMbps": 35,
  "firewallL3AccessControlPolicyId": "6d32d2c5-2edf-443e-915f-4e582fd73355",
  "firewallL2AccessControlPolicyId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "firewallAppPolicyId": "ae6f9c41-4c8a-4ac7-923a-22e9057c70d8",
  "firewallUrlFilteringPolicyId": "dbbcdebb-8270-cbdc-ae24-3cda35530503",
  "firewallDevicePolicyId": "fe10ea25-a32e-4824-8b3a-47320180e1a0",
  "advancedOptions": {
    "uplinkEnabled": false,
    "downlinkEnabled": false,
    "clientIsoationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": false,
    "dgafEnabled": null,
    "maxClientsPerRadio": 100,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "antiSpoofingEnabled": true,
    "arpRequestRateLimit": 15,
    "dhcpRequestRateLimit": 15,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientIdleTimeoutSec": 120,
    "clientFingerprintingEnabled": false,
    "multicastFilterDrop": false,
    "ofdmOnlyEnabled": false,
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "hs20Onboarding": false,
    "avcEnabled": true,
    "bandBalancing": "UseZoneSetting",
    "dtimInterval": 1,
    "directedThreshold": 5,
    "multicastUplinkRateLimitEnabled": true,
    "multicastUplinkRateLimit": 10,
    "multicastDownlinkRateLimitEnabled": true,
    "multicastDownlinkRateLimit": 20,
    "urlFilteringPolicyEnabled": false,
    "urlFilteringPolicyId": "",
    "wifiCallingPolicyEnabled": false,
    "wifiCallingPolicyIds": [],
    "hdOverheadOptimizeEnable": false,
    "probeRssiThr": -85,
    "transientClientMgmtEnable": true,
    "joinIgnoreTimeout": 30,
    "joinAcceptTimeout": 300,
    "joinIgnoreThr": 10,
    "authRssiThr": -85,
    "assocRssiThr": -85
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dpsk": {
    "dpskEnabled": true,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "bssid": [
    "E0:10:7F:28:C9:D8",
    "E0:10:7F:28:C9:DC"
  ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the WLAN",
            "type" : "string"
        },
        "zoneId" : {
            "description" : "Identifier of the zone to which the WLAN belongs",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : "string"
        },
        "type" : {
            "description" : "Type of the WLAN",
            "type" : "string",
            "enum" : [ "Standard_Open", "Standard_8021X", "Standard_Mac", "Hotspot", "Hotspot_MacByPass", "Guest", "WebAuth", "Hotspot20", "Hotspot20_Open", "Hotspot20_OSEN" ]
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean"
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "oweTransWlanId" : {
            "description" : "The other wlan id of the OWE-Transition mode WLANs. ",
            "type" : "string"
        },
        "authServiceOrProfile" : {
            "description" : "Autentication of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "macAuth" : {
            "description" : "MAC authentication of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean",
            "default" : false
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "socialMediaLoginProfileId" : {
            "type" : "string"
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094,
                    "default" : 1
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                    "default" : "WLAN_BSSID"
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{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",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ],
                    "default" : "WLAN_BSSID"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ],
                    "default" : "High"
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean",
                    "default" : false
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "default" : 100,
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400,
                    "default" : 120
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000,
                    "default" : 172800
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "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. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean",
                    "default" : false
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean",
                    "default" : false
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "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",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ],
                    "default" : "UseZoneSetting"
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "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" ],
                    "default" : "2 mbps"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60",
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600,
                            "default" : 30
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ],
                            "default" : "ALL"
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "bssid" : {
            "description" : "BSSID of the WLAN",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean",
            "default" : false
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean",
            "default" : false
        }
    }
}

Query WLANs

POST/v11_1/query/wlan

Query WLANs with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 5,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "name": "None",
      "status": null,
      "alerts": null,
      "ssid": "None",
      "authMethod": "OPEN",
      "encryptionMethod": "NONE",
      "clients": null,
      "traffic": null,
      "vlan": 1,
      "applicationVisibility": "Disabled",
      "clientVirtualIdExtractionEnabled": "Disabled",
      "tunneled": "APBridged",
      "zeroITOnboard": "Disabled",
      "zeroITEnabled": "Disabled",
      "trafficUplink": null,
      "trafficDownlink": null,
      "enability11r": null,
      "enability11k": null,
      "description": "",
      "wlanId": "5",
      "wpaVersion": "",
      "wepEncryptionStrength": 0,
      "availability": 1,
      "tenantId": "",
      "tenantDomainName": "",
      "firewallProfileId": null
    },
    {
      "name": "WEP128",
      "status": null,
      "alerts": null,
      "ssid": "WEP128",
      "authMethod": "OPEN",
      "encryptionMethod": "WEP",
      "clients": null,
      "traffic": null,
      "vlan": 1,
      "applicationVisibility": "Disabled",
      "clientVirtualIdExtractionEnabled": "Disabled",
      "tunneled": "APBridged",
      "zeroITOnboard": "Disabled",
      "zeroITEnabled": "Disabled",
      "trafficUplink": null,
      "trafficDownlink": null,
      "enability11r": null,
      "enability11k": null,
      "description": "",
      "wlanId": "4",
      "wpaVersion": "WEP128",
      "wepEncryptionStrength": 26,
      "tenantId": "",
      "tenantDomainName": "",
      "firewallProfileId": null
    },
    {
      "name": "WEP64",
      "status": null,
      "alerts": null,
      "ssid": "WEP64",
      "authMethod": "OPEN",
      "encryptionMethod": "WEP",
      "clients": null,
      "traffic": null,
      "vlan": 1,
      "applicationVisibility": "Disabled",
      "clientVirtualIdExtractionEnabled": "Disabled",
      "tunneled": "APBridged",
      "zeroITOnboard": "Disabled",
      "zeroITEnabled": "Disabled",
      "trafficUplink": null,
      "trafficDownlink": null,
      "enability11r": null,
      "enability11k": null,
      "description": "",
      "wlanId": "3",
      "wpaVersion": "WEP64",
      "wepEncryptionStrength": 10,
      "tenantId": "",
      "tenantDomainName": "",
      "firewallProfileId": "607f0c32-c219-11e8-aa07-000000539553"
    },
    {
      "name": "WPA-Mixed",
      "status": null,
      "alerts": null,
      "ssid": "WPA-Mixed",
      "authMethod": "OPEN",
      "encryptionMethod": "WPA",
      "clients": null,
      "traffic": null,
      "vlan": 1,
      "applicationVisibility": "Disabled",
      "clientVirtualIdExtractionEnabled": "Disabled",
      "tunneled": "APBridged",
      "zeroITOnboard": "Disabled",
      "zeroITEnabled": "Disabled",
      "trafficUplink": null,
      "trafficDownlink": null,
      "enability11r": null,
      "enability11k": null,
      "description": "",
      "wlanId": "2",
      "wpaVersion": "AUTO",
      "wepEncryptionStrength": 0,
      "tenantId": "",
      "tenantDomainName": "",
      "firewallProfileId": "607f0c32-c219-11e8-aa07-000000539553"
    },
    {
      "name": "wpa2",
      "status": null,
      "alerts": null,
      "ssid": "wpa2",
      "authMethod": "OPEN",
      "encryptionMethod": "WPA",
      "clients": null,
      "traffic": null,
      "vlan": 1,
      "applicationVisibility": "Disabled",
      "clientVirtualIdExtractionEnabled": "Disabled",
      "tunneled": "APBridged",
      "zeroITOnboard": "Disabled",
      "zeroITEnabled": "Disabled",
      "trafficUplink": null,
      "trafficDownlink": null,
      "enability11r": null,
      "enability11k": null,
      "description": "",
      "wlanId": "1",
      "wpaVersion": "WPA2",
      "wepEncryptionStrength": 0,
      "tenantId": "",
      "tenantDomainName": "",
      "firewallProfileId": "607f0c32-c219-11e8-aa07-000000539553"
    }
  ],
  "extra": {
    "rbacMetadata": [
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      },
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      },
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      },
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      },
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      }
    ]
  }
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "totalCount": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for wlan list",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "clients": {
            "type": "integer"
          },
          "applicationVisibility": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "clientVirtualIdExtractionEnabled": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "zeroITOnboard": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "trafficUplink": {
            "type": "integer"
          },
          "description": {
            "type": "string"
          },
          "zeroITEnabled": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "ssid": {
            "type": "string"
          },
          "wlanId": {
            "type": "string"
          },
          "encryptionMethod": {
            "type": "string"
          },
          "enability11k": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "alerts": {
            "type": "integer"
          },
          "tunneled": {
            "type": "string",
            "enum": [
              "Tunneled",
              "APBridged"
            ]
          },
          "vlan": {
            "type": "integer"
          },
          "enability11r": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "name": {
            "type": "string"
          },
          "authMethod": {
            "type": "string"
          },
          "authType": {
            "type": "string"
          },
          "domainName": {
            "type": "string"
          },
          "zoneName": {
            "type": "string"
          },
          "zoneId": {
            "type": "string"
          },
          "trafficDownlink": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "Online",
              "Flagged",
              "Offline"
            ]
          },
          "traffic": {
            "type": "integer"
          },
          "wpaVersion": {
            "type": "string"
          },
          "wepEncryptionStrength": {
            "type": "integer"
          },
          "availability": {
            "type": "integer"
          },
          "tenantId": {
            "type": "string"
          },
          "tenantDomainName": {
            "type": "string"
          },
          "utp": {
            "type": "string"
          },
          "firewallProfileId": {
            "type": "string"
          },
          "firewallProfile": {
            "type": "string"
          },
          "oweTransWlanId": {
            "type": "string"
          }
        }
      }
    }
  }
}

Create - Standard Open

POST/v11_1/rkszones/{zoneId}/wlans

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

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "accessTunnelType": "RuckusGRE",
  "accessTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "accessIpsecProfile": null,
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "passphrase": "password",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "operatorRealm": "operator realm",
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "coreQinQEnabled": false,
    "coreSVlan": 1,
    "vlanPooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "b89323e1-3168-11e7-b027-5254009ae3f0",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 60,
    "wifi6Enabled": true,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "ndProxyEnabled": false,
    "suppressNsEnabled": false,
    "raProxyEnabled": false,
    "rsraGuardEnabled": false,
    "raThrottlingEnabled": false,
    "maxAllowedRA": 10,
    "raInterval": 10,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "antiSpoofingEnabled": true,
    "arpRequestRateLimit": 15,
    "dhcpRequestRateLimit": 15,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "multicastFilterDrop": false,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "uplinkEnabled": true,
    "uplinkRate": 100,
    "downlinkEnabled": true,
    "downlinkRate": 200,
    "multicastUplinkRateLimitEnabled": true,
    "multicastUplinkRateLimit": 10,
    "multicastDownlinkRateLimitEnabled": true,
    "multicastDownlinkRateLimit": 20,
    "multicastUplinkRateLimit6gEnabled": true,
    "multicastDownlinkRateLimit6gEnabled": true,
    "ratePerSTAUplink": "650mbps",
    "ratePerSTADownlink": "1mbps",
    "urlFilteringPolicyEnabled": true,
    "urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
    "wifiCallingPolicyEnabled": true,
    "wifiCallingPolicyIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ],
    "hdOverheadOptimizeEnable": false,
    "probeRssiThr": -85,
    "transientClientMgmtEnable": true,
    "joinIgnoreTimeout": 30,
    "joinAcceptTimeout": 300,
    "joinIgnoreThr": 10,
    "dropRandomProbesEnabled": true,
    "authRssiThr": -85,
    "assocRssiThr": -85,
    "dnsSpoofingProfileId": "b7ef88c1-22e3-11e9-8743-d29f54e2dacd",
    "vlanNameProfileId": "1aef0e54-b0dd-4285-8916-ac8730f14276"
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dnsServerProfile": {
    "id": "DNS server profile UUID",
    "name": "DNS server profile name"
  },
  "dpsk": {
    "dpskEnabled": true,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": false,
    "encryption": {
      "method": "None"
    }
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ],
            "default" : "APLBO"
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean",
            "default" : false
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094,
                    "default" : 1
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                    "default" : "WLAN_BSSID"
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{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",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ],
                    "default" : "WLAN_BSSID"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ],
                    "default" : "High"
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean",
                    "default" : false
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "default" : 100,
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400,
                    "default" : 120
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000,
                    "default" : 172800
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "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. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean",
                    "default" : false
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean",
                    "default" : false
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "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",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ],
                    "default" : "UseZoneSetting"
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "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" ],
                    "default" : "2 mbps"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60",
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600,
                            "default" : 30
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ],
                            "default" : "ALL"
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean",
            "default" : false
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean",
            "default" : false
        }
    },
    "required" : [ "name", "ssid" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - 802.1X

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

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

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "authServiceOrProfile": {
    "throughController": false,
    "id": "authServiceUUID",
    "name": "authServiceName",
    "authenticationOption": null
  },
  "accessTunnelType": "RuckusGRE",
  "accessTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "operatorRealm": "operator realm",
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "aaaVlanOverride": true,
    "coreQinQEnabled": false,
    "coreSVlan": 1,
    "vlanPooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "firewallProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "firewallWlanSpecificEnabled": true,
  "firewallUplinkRateLimitingMbps": 20,
  "firewallDownlinkRateLimitingMbps": 35,
  "firewallL3AccessControlPolicyId": "6d32d2c5-2edf-443e-915f-4e582fd73355",
  "firewallL2AccessControlPolicyId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "firewallAppPolicyId": "ae6f9c41-4c8a-4ac7-923a-22e9057c70d8",
  "firewallUrlFilteringPolicyId": "dbbcdebb-8270-cbdc-ae24-3cda35530503",
  "firewallDevicePolicyId": "fe10ea25-a32e-4824-8b3a-47320180e1a0",
  "wifiAgileMultibandEnabled": false,
  "apHostNameAdvertisementEnabled": false,
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "b89323e1-3168-11e7-b027-5254009ae3f0",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 60,
    "userSessionTimeout": 172800,
    "wifi6Enabled": true,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "ndProxyEnabled": false,
    "suppressNsEnabled": false,
    "raProxyEnabled": false,
    "rsraGuardEnabled": false,
    "raThrottlingEnabled": false,
    "maxAllowedRA": 10,
    "raInterval": 10,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "multicastFilterDrop": false,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "urlFilteringPolicyEnabled": true,
    "urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
    "wifiCallingPolicyEnabled": true,
    "wifiCallingPolicyIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ],
    "uplinkEnabled": true,
    "uplinkRate": 100,
    "downlinkEnabled": true,
    "downlinkRate": 200,
    "multicastUplinkRateLimitEnabled": true,
    "multicastUplinkRateLimit": 10,
    "multicastDownlinkRateLimitEnabled": true,
    "multicastDownlinkRateLimit": 20,
    "multicastUplinkRateLimit6gEnabled": true,
    "multicastDownlinkRateLimit6gEnabled": true,
    "ratePerSTAUplink": "650mbps",
    "ratePerSTADownlink": "1mbps",
    "dnsSpoofingProfileId": "b7ef88c1-22e3-11e9-8743-d29f54e2dacd",
    "vlanNameProfileId": "1aef0e54-b0dd-4285-8916-ac8730f14276"
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dnsServerProfile": {
    "id": "DNS server profile UUID",
    "name": "DNS server profile name"
  },
  "dpsk": {
    "dpskEnabled": false,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES",
      "mfp": "disabled"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable  for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable  for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean",
            "default" : false
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094,
                    "default" : 1
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                    "default" : "WLAN_BSSID"
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{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",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ],
                    "default" : "WLAN_BSSID"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ],
                    "default" : "High"
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean",
                    "default" : false
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "default" : 100,
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400,
                    "default" : 120
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000,
                    "default" : 172800
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "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. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean",
                    "default" : false
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean",
                    "default" : false
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "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",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ],
                    "default" : "UseZoneSetting"
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "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" ],
                    "default" : "2 mbps"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60",
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600,
                            "default" : 30
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ],
                            "default" : "ALL"
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean",
            "default" : false
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean",
            "default" : false
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - 802.1X with MAC Address

POST/v11_1/rkszones/{zoneId}/wlans/standard8021Xmac

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

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "authServiceOrProfile": {
    "throughController": false,
    "id": "authServiceUUID",
    "name": "authServiceName",
    "authenticationOption": null
  },
  "accessTunnelType": "RuckusGRE",
  "accessTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "operatorRealm": "operator realm",
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "aaaVlanOverride": true,
    "coreQinQEnabled": false,
    "coreSVlan": 1,
    "vlanPooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "firewallProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "firewallWlanSpecificEnabled": true,
  "firewallUplinkRateLimitingMbps": 20,
  "firewallDownlinkRateLimitingMbps": 35,
  "firewallL3AccessControlPolicyId": "6d32d2c5-2edf-443e-915f-4e582fd73355",
  "firewallL2AccessControlPolicyId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "firewallAppPolicyId": "ae6f9c41-4c8a-4ac7-923a-22e9057c70d8",
  "firewallUrlFilteringPolicyId": "dbbcdebb-8270-cbdc-ae24-3cda35530503",
  "firewallDevicePolicyId": "fe10ea25-a32e-4824-8b3a-47320180e1a0",
  "wifiAgileMultibandEnabled": false,
  "apHostNameAdvertisementEnabled": false,
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "b89323e1-3168-11e7-b027-5254009ae3f0",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 60,
    "userSessionTimeout": 172800,
    "wifi6Enabled": true,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "ndProxyEnabled": false,
    "suppressNsEnabled": false,
    "raProxyEnabled": false,
    "rsraGuardEnabled": false,
    "raThrottlingEnabled": false,
    "maxAllowedRA": 10,
    "raInterval": 10,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "multicastFilterDrop": false,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "urlFilteringPolicyEnabled": true,
    "urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
    "wifiCallingPolicyEnabled": true,
    "wifiCallingPolicyIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ],
    "uplinkEnabled": true,
    "uplinkRate": 100,
    "downlinkEnabled": true,
    "downlinkRate": 200,
    "multicastUplinkRateLimitEnabled": true,
    "multicastUplinkRateLimit": 10,
    "multicastDownlinkRateLimitEnabled": true,
    "multicastDownlinkRateLimit": 20,
    "multicastUplinkRateLimit6gEnabled": true,
    "multicastDownlinkRateLimit6gEnabled": true,
    "ratePerSTAUplink": "650mbps",
    "ratePerSTADownlink": "1mbps",
    "dnsSpoofingProfileId": "b7ef88c1-22e3-11e9-8743-d29f54e2dacd",
    "vlanNameProfileId": "1aef0e54-b0dd-4285-8916-ac8730f14276"
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dnsServerProfile": {
    "id": "DNS server profile UUID",
    "name": "DNS server profile name"
  },
  "dpsk": {
    "dpskEnabled": false,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES",
      "mfp": "disabled"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable  for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable  for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean",
            "default" : false
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094,
                    "default" : 1
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                    "default" : "WLAN_BSSID"
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{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",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ],
                    "default" : "WLAN_BSSID"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ],
                    "default" : "High"
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean",
                    "default" : false
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "default" : 100,
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400,
                    "default" : 120
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000,
                    "default" : 172800
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "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. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean",
                    "default" : false
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean",
                    "default" : false
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "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",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ],
                    "default" : "UseZoneSetting"
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "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" ],
                    "default" : "2 mbps"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60",
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600,
                            "default" : 30
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ],
                            "default" : "ALL"
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean",
            "default" : false
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean",
            "default" : false
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - MAC Auth

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

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

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "authServiceOrProfile": {
    "throughController": false,
    "id": "authServiceUUID",
    "name": "authServiceName",
    "authenticationOption": null
  },
  "accessTunnelType": "RuckusGRE",
  "accessTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "operatorRealm": "operator realm",
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "aaaVlanOverride": true,
    "coreQinQEnabled": false,
    "coreSVlan": 1,
    "vlanPooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "firewallProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "firewallWlanSpecificEnabled": true,
  "firewallUplinkRateLimitingMbps": 20,
  "firewallDownlinkRateLimitingMbps": 35,
  "firewallL3AccessControlPolicyId": "6d32d2c5-2edf-443e-915f-4e582fd73355",
  "firewallL2AccessControlPolicyId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "firewallAppPolicyId": "ae6f9c41-4c8a-4ac7-923a-22e9057c70d8",
  "firewallUrlFilteringPolicyId": "dbbcdebb-8270-cbdc-ae24-3cda35530503",
  "firewallDevicePolicyId": "fe10ea25-a32e-4824-8b3a-47320180e1a0",
  "wifiAgileMultibandEnabled": false,
  "apHostNameAdvertisementEnabled": false,
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "b89323e1-3168-11e7-b027-5254009ae3f0",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 60,
    "userSessionTimeout": 172800,
    "wifi6Enabled": true,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "ndProxyEnabled": false,
    "suppressNsEnabled": false,
    "raProxyEnabled": false,
    "rsraGuardEnabled": false,
    "raThrottlingEnabled": false,
    "maxAllowedRA": 10,
    "raInterval": 10,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "multicastFilterDrop": false,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "urlFilteringPolicyEnabled": true,
    "urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
    "wifiCallingPolicyEnabled": true,
    "wifiCallingPolicyIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ],
    "uplinkEnabled": true,
    "uplinkRate": 100,
    "downlinkEnabled": true,
    "downlinkRate": 200,
    "multicastUplinkRateLimitEnabled": true,
    "multicastUplinkRateLimit": 10,
    "multicastDownlinkRateLimitEnabled": true,
    "multicastDownlinkRateLimit": 20,
    "multicastUplinkRateLimit6gEnabled": true,
    "multicastDownlinkRateLimit6gEnabled": true,
    "ratePerSTAUplink": "650mbps",
    "ratePerSTADownlink": "1mbps",
    "dnsSpoofingProfileId": "b7ef88c1-22e3-11e9-8743-d29f54e2dacd",
    "vlanNameProfileId": "1aef0e54-b0dd-4285-8916-ac8730f14276"
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dnsServerProfile": {
    "id": "DNS server profile UUID",
    "name": "DNS server profile name"
  },
  "dpsk": {
    "dpskEnabled": false,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES",
      "mfp": "disabled"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable  for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable  for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean",
            "default" : false
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094,
                    "default" : 1
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                    "default" : "WLAN_BSSID"
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{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",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ],
                    "default" : "WLAN_BSSID"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ],
                    "default" : "High"
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean",
                    "default" : false
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "default" : 100,
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400,
                    "default" : 120
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000,
                    "default" : 172800
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "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. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean",
                    "default" : false
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean",
                    "default" : false
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "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",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ],
                    "default" : "UseZoneSetting"
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "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" ],
                    "default" : "2 mbps"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60",
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600,
                            "default" : 30
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ],
                            "default" : "ALL"
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean",
            "default" : false
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean",
            "default" : false
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot

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

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

Request
HideShow
Body
‧ Sample : Create a Hotspot (WISPr) WLAN with default configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName",
        "authenticationOption" : null,
        "backupAuthenticationId" : "otherAuthServiceUUID",
        "backupAuthenticationOption" : null
    },
    "accountingServiceOrProfile" : {
        "id" : "acctingServiceUUID",
        "name" : "acctingServiceName",
        "throughController" : false,
        "realmBasedAcct" : false,
        "interimUpdateMin" : 10,
        "accountingDelayEnabled" : false,
        "backupAccountingId" : "otherAccountingServiceUUID",
        "backupAccountingName" : "otherAccountingServiceName"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    },
    "accessTunnelType" : "RuckusGRE",
    "accessTunnelProfile" : {
        "id" : "f5b92938-aa4e-4d02-90ea-273799ff689b",
        "name" : "Default Tunnel Profile"
    },
    "splitTunnelProfileId" : "38119bac-49e1-4410-ab8e-1c1bc88dd770",
    "coreTunnelProfile" : {
        "type" : "Bridge",
        "id" : "forwardingUUID",
        "name" : "forwardingName"
    },
    "encryption" : {
        "method" : "WPA2",
        "algorithm" : "AES",
        "passphrase" : "password",
        "mfp" : "disabled",
        "support80211rEnabled" : true,
        "mobilityDomainId" : 3
    },
    "operatorRealm" : "operator realm",
    "defaultUserTrafficProfile" : {
        "id" : "userTrafficUUID",
        "name" : "userTrafficName"
    },
    "precedenceProfileId" : "c514d450-c839-9527-afc9-525400d12345",
    "portalDetectionProfileId" : "de0fa30c-9565-11e8-9eb6-529269fb1459",
    "schedule" : {
        "type" : "Customized",
        "id" : "ServiceUUID",
        "name" : "ServiceName"
    },
    "vlan" : {
        "accessVlan" : 23,
        "coreQinQEnabled" : false,
        "coreSVlan" : 1,
        "vlanPooling" : null
    },
    "l2ACL" : {
        "id" : "l2ACLUUID",
        "name" : "l2ACLName"
    },
    "devicePolicy" : {
        "id" : "devicePolicyUUID",
        "name" : "devicePolicyName"
    },
    "radiusOptions" : {
        "nasIdType" : "Customized",
        "customizedNasId" : "nasId",
        "nasRequestTimeoutSec" : 12,
        "nasMaxRetry" : 3,
        "nasReconnectPrimaryMin" : 30,
        "calledStaIdType" : "WLAN_BSSID",
        "nasIpType" : "disabled",
        "nasIpUserDefined" : "192.168.1.1",
        "vendorSpecificAttributeProfileId" : "6d767421-d1b7-11e8-8ab9-ba2343155a93"
    },
    "firewallProfileId" : "c514d450-c839-9527-afc9-525400d12345",
    "firewallWlanSpecificEnabled" : true,
    "firewallUplinkRateLimitingMbps" : 20,
    "firewallDownlinkRateLimitingMbps" : 35,
    "firewallL3AccessControlPolicyId" : "6d32d2c5-2edf-443e-915f-4e582fd73355",
    "firewallL2AccessControlPolicyId" : "839f87c6-d116-497e-afce-aa8157abd30c",
    "firewallAppPolicyId" : "ae6f9c41-4c8a-4ac7-923a-22e9057c70d8",
    "firewallUrlFilteringPolicyId" : "dbbcdebb-8270-cbdc-ae24-3cda35530503",
    "firewallDevicePolicyId" : "fe10ea25-a32e-4824-8b3a-47320180e1a0",
    "wifiAgileMultibandEnabled" : false,
    "apHostNameAdvertisementEnabled" : false,
    "advancedOptions" : {
        "clientIsolationEnabled" : true,
        "clientIsolationUnicastEnabled" : true,
        "clientIsolationMulticastEnabled" : false,
        "clientIsolationAutoVrrpEnabled" : false,
        "clientIsolationWhitelist" : {
            "id" : "b89323e1-3168-11e7-b027-5254009ae3f0",
            "name" : "myWhitelist"
        },
        "priority" : "High",
        "hideSsidEnabled" : true,
        "maxClientsPerRadio" : 12,
        "wifi6Enabled" : true,
        "clientIdleTimeoutSec" : 60,
        "userSessionTimeout" : 172800,
        "clientLoadBalancingEnabled" : true,
        "proxyARPEnabled" : true,
        "ndProxyEnabled" : false,
        "suppressNsEnabled" : false,
        "raProxyEnabled" : false,
        "rsraGuardEnabled" : false,
        "raThrottlingEnabled" : false,
        "maxAllowedRA" : 10,
        "raInterval" : 10,
        "support80211dEnabled" : false,
        "support80211kEnabled" : true,
        "forceClientDHCPTimeoutSec" : 5,
        "dhcp82SubOpt1Format" : "SUBOPT1_AP_INFO_LOCATION",
        "unauthClientStatsEnabled" : false,
        "clientFingerprintingEnabled" : true,
        "multicastFilterDrop" : false,
        "ofdmOnlyEnabled" : false,
        "bandBalancing" : "UseZoneSetting",
        "bssMinRateMbps" : "Disable",
        "mgmtTxRateMbps" : "2 mbps",
        "avcEnabled" : true,
        "urlFilteringPolicyEnabled" : false,
        "urlFilteringPolicyId" : "",
        "wifiCallingPolicyEnabled" : false,
        "wifiCallingPolicyIds" : [ ],
        "uplinkEnabled" : true,
        "uplinkRate" : 100,
        "downlinkEnabled" : true,
        "downlinkRate" : 200,
        "multicastUplinkRateLimitEnabled" : true,
        "multicastUplinkRateLimit" : 10,
        "multicastDownlinkRateLimitEnabled" : true,
        "multicastDownlinkRateLimit" : 20,
        "multicastUplinkRateLimit6gEnabled" : true,
        "multicastDownlinkRateLimit6gEnabled" : true,
        "ratePerSTAUplink" : "650mbps",
        "ratePerSTADownlink" : "1mbps",
        "dnsSpoofingProfileId" : "b7ef88c1-22e3-11e9-8743-d29f54e2dacd",
        "vlanNameProfileId" : "1aef0e54-b0dd-4285-8916-ac8730f14276"
    },
    "diffServProfile" : {
        "id" : "diffServId",
        "name" : "diffServName"
    },
    "qosMaps" : [ {
        "enable" : true,
        "priority" : 0,
        "low" : 0,
        "high" : 7,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 1,
        "low" : 8,
        "high" : 15,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 2,
        "low" : 16,
        "high" : 23,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 3,
        "low" : 0,
        "high" : 32,
        "excepts" : [ 43, 45, 60 ]
    }, {
        "enable" : true,
        "priority" : 4,
        "low" : 32,
        "high" : 39,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 5,
        "low" : 40,
        "high" : 47,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 6,
        "low" : 48,
        "high" : 55,
        "excepts" : [ 46 ]
    }, {
        "enable" : true,
        "priority" : 7,
        "low" : 56,
        "high" : 63,
        "excepts" : null
    } ],
    "dnsServerProfile" : {
        "id" : "DNS server profile UUID",
        "name" : "DNS server profile name"
    },
    "dpsk" : {
        "dpskEnabled" : false,
        "length" : 8,
        "dpskType" : "Secure",
        "expiration" : "OneDay",
        "dpskFromType" : "FirstUse"
    },
    "externalDpsk" : {
        "enabled" : true,
        "encryption" : {
            "method" : "WPA2",
            "algorithm" : "AES",
            "mfp" : "disabled"
        },
        "authService" : {
            "id" : "authServiceUUID"
        }
    }
}
‧ Sample : Create a Hotspot (WISPr) WLAN allows Hotspot 2.0 Onboarding
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    },
    "advancedOptions" : {
        "hs20Onboarding" : true
    }
}
‧ Sample : Create a Hotspot (WISPr) WLAN with authenticationOption configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : true,
        "authenticationOption" : "Local DB",
        "backupAuthenticationId" : "otherAuthServiceUUID",
        "backupAuthenticationOption" : null
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean",
            "default" : false
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "portalServiceProfile" : {
            "description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean",
            "default" : false
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094,
                    "default" : 1
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                    "default" : "WLAN_BSSID"
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{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",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ],
                    "default" : "WLAN_BSSID"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ],
                    "default" : "High"
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean",
                    "default" : false
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "default" : 100,
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400,
                    "default" : 120
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000,
                    "default" : 172800
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "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. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean",
                    "default" : false
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean",
                    "default" : false
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "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",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ],
                    "default" : "UseZoneSetting"
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "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" ],
                    "default" : "2 mbps"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60",
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600,
                            "default" : 30
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ],
                            "default" : "ALL"
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean",
            "default" : false
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean",
            "default" : false
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot + MAC bypass

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

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

Request
HideShow
Body
‧ Sample : Create a Hotspot (WISPr) WLAN with default configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName",
        "authenticationOption" : null,
        "backupAuthenticationId" : "otherAuthServiceUUID",
        "backupAuthenticationOption" : null
    },
    "accountingServiceOrProfile" : {
        "id" : "acctingServiceUUID",
        "name" : "acctingServiceName",
        "throughController" : false,
        "realmBasedAcct" : false,
        "interimUpdateMin" : 10,
        "accountingDelayEnabled" : false,
        "backupAccountingId" : "otherAccountingServiceUUID",
        "backupAccountingName" : "otherAccountingServiceName"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    },
    "accessTunnelType" : "RuckusGRE",
    "accessTunnelProfile" : {
        "id" : "f5b92938-aa4e-4d02-90ea-273799ff689b",
        "name" : "Default Tunnel Profile"
    },
    "splitTunnelProfileId" : "38119bac-49e1-4410-ab8e-1c1bc88dd770",
    "coreTunnelProfile" : {
        "type" : "Bridge",
        "id" : "forwardingUUID",
        "name" : "forwardingName"
    },
    "encryption" : {
        "method" : "WPA2",
        "algorithm" : "AES",
        "passphrase" : "password",
        "mfp" : "disabled",
        "support80211rEnabled" : true,
        "mobilityDomainId" : 3
    },
    "operatorRealm" : "operator realm",
    "defaultUserTrafficProfile" : {
        "id" : "userTrafficUUID",
        "name" : "userTrafficName"
    },
    "precedenceProfileId" : "c514d450-c839-9527-afc9-525400d12345",
    "portalDetectionProfileId" : "de0fa30c-9565-11e8-9eb6-529269fb1459",
    "schedule" : {
        "type" : "Customized",
        "id" : "ServiceUUID",
        "name" : "ServiceName"
    },
    "vlan" : {
        "accessVlan" : 23,
        "coreQinQEnabled" : false,
        "coreSVlan" : 1,
        "vlanPooling" : null
    },
    "l2ACL" : {
        "id" : "l2ACLUUID",
        "name" : "l2ACLName"
    },
    "devicePolicy" : {
        "id" : "devicePolicyUUID",
        "name" : "devicePolicyName"
    },
    "radiusOptions" : {
        "nasIdType" : "Customized",
        "customizedNasId" : "nasId",
        "nasRequestTimeoutSec" : 12,
        "nasMaxRetry" : 3,
        "nasReconnectPrimaryMin" : 30,
        "calledStaIdType" : "WLAN_BSSID",
        "nasIpType" : "disabled",
        "nasIpUserDefined" : "192.168.1.1",
        "vendorSpecificAttributeProfileId" : "6d767421-d1b7-11e8-8ab9-ba2343155a93"
    },
    "firewallProfileId" : "c514d450-c839-9527-afc9-525400d12345",
    "firewallWlanSpecificEnabled" : true,
    "firewallUplinkRateLimitingMbps" : 20,
    "firewallDownlinkRateLimitingMbps" : 35,
    "firewallL3AccessControlPolicyId" : "6d32d2c5-2edf-443e-915f-4e582fd73355",
    "firewallL2AccessControlPolicyId" : "839f87c6-d116-497e-afce-aa8157abd30c",
    "firewallAppPolicyId" : "ae6f9c41-4c8a-4ac7-923a-22e9057c70d8",
    "firewallUrlFilteringPolicyId" : "dbbcdebb-8270-cbdc-ae24-3cda35530503",
    "firewallDevicePolicyId" : "fe10ea25-a32e-4824-8b3a-47320180e1a0",
    "wifiAgileMultibandEnabled" : false,
    "apHostNameAdvertisementEnabled" : false,
    "advancedOptions" : {
        "clientIsolationEnabled" : true,
        "clientIsolationUnicastEnabled" : true,
        "clientIsolationMulticastEnabled" : false,
        "clientIsolationAutoVrrpEnabled" : false,
        "clientIsolationWhitelist" : {
            "id" : "b89323e1-3168-11e7-b027-5254009ae3f0",
            "name" : "myWhitelist"
        },
        "priority" : "High",
        "hideSsidEnabled" : true,
        "maxClientsPerRadio" : 12,
        "wifi6Enabled" : true,
        "clientIdleTimeoutSec" : 60,
        "userSessionTimeout" : 172800,
        "clientLoadBalancingEnabled" : true,
        "proxyARPEnabled" : true,
        "ndProxyEnabled" : false,
        "suppressNsEnabled" : false,
        "raProxyEnabled" : false,
        "rsraGuardEnabled" : false,
        "raThrottlingEnabled" : false,
        "maxAllowedRA" : 10,
        "raInterval" : 10,
        "support80211dEnabled" : false,
        "support80211kEnabled" : true,
        "forceClientDHCPTimeoutSec" : 5,
        "dhcp82SubOpt1Format" : "SUBOPT1_AP_INFO_LOCATION",
        "unauthClientStatsEnabled" : false,
        "clientFingerprintingEnabled" : true,
        "multicastFilterDrop" : false,
        "ofdmOnlyEnabled" : false,
        "bandBalancing" : "UseZoneSetting",
        "bssMinRateMbps" : "Disable",
        "mgmtTxRateMbps" : "2 mbps",
        "avcEnabled" : true,
        "urlFilteringPolicyEnabled" : false,
        "urlFilteringPolicyId" : "",
        "wifiCallingPolicyEnabled" : false,
        "wifiCallingPolicyIds" : [ ],
        "uplinkEnabled" : true,
        "uplinkRate" : 100,
        "downlinkEnabled" : true,
        "downlinkRate" : 200,
        "multicastUplinkRateLimitEnabled" : true,
        "multicastUplinkRateLimit" : 10,
        "multicastDownlinkRateLimitEnabled" : true,
        "multicastDownlinkRateLimit" : 20,
        "multicastUplinkRateLimit6gEnabled" : true,
        "multicastDownlinkRateLimit6gEnabled" : true,
        "ratePerSTAUplink" : "650mbps",
        "ratePerSTADownlink" : "1mbps",
        "dnsSpoofingProfileId" : "b7ef88c1-22e3-11e9-8743-d29f54e2dacd",
        "vlanNameProfileId" : "1aef0e54-b0dd-4285-8916-ac8730f14276"
    },
    "diffServProfile" : {
        "id" : "diffServId",
        "name" : "diffServName"
    },
    "qosMaps" : [ {
        "enable" : true,
        "priority" : 0,
        "low" : 0,
        "high" : 7,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 1,
        "low" : 8,
        "high" : 15,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 2,
        "low" : 16,
        "high" : 23,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 3,
        "low" : 0,
        "high" : 32,
        "excepts" : [ 43, 45, 60 ]
    }, {
        "enable" : true,
        "priority" : 4,
        "low" : 32,
        "high" : 39,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 5,
        "low" : 40,
        "high" : 47,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 6,
        "low" : 48,
        "high" : 55,
        "excepts" : [ 46 ]
    }, {
        "enable" : true,
        "priority" : 7,
        "low" : 56,
        "high" : 63,
        "excepts" : null
    } ],
    "dnsServerProfile" : {
        "id" : "DNS server profile UUID",
        "name" : "DNS server profile name"
    },
    "dpsk" : {
        "dpskEnabled" : false,
        "length" : 8,
        "dpskType" : "Secure",
        "expiration" : "OneDay",
        "dpskFromType" : "FirstUse"
    },
    "externalDpsk" : {
        "enabled" : true,
        "encryption" : {
            "method" : "WPA2",
            "algorithm" : "AES",
            "mfp" : "disabled"
        },
        "authService" : {
            "id" : "authServiceUUID"
        }
    }
}
‧ Sample : Create a Hotspot (WISPr) WLAN allows Hotspot 2.0 Onboarding
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    },
    "advancedOptions" : {
        "hs20Onboarding" : true
    }
}
‧ Sample : Create a Hotspot (WISPr) WLAN with authenticationOption configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : true,
        "authenticationOption" : "Local DB",
        "backupAuthenticationId" : "otherAuthServiceUUID",
        "backupAuthenticationOption" : null
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean",
            "default" : false
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "portalServiceProfile" : {
            "description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean",
            "default" : false
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094,
                    "default" : 1
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                    "default" : "WLAN_BSSID"
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{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",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ],
                    "default" : "WLAN_BSSID"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ],
                    "default" : "High"
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean",
                    "default" : false
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "default" : 100,
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400,
                    "default" : 120
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000,
                    "default" : 172800
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "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. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean",
                    "default" : false
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean",
                    "default" : false
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "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",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ],
                    "default" : "UseZoneSetting"
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "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" ],
                    "default" : "2 mbps"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60",
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600,
                            "default" : 30
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ],
                            "default" : "ALL"
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean",
            "default" : false
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean",
            "default" : false
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot + 802.1X

POST/v11_1/rkszones/{zoneId}/wlans/wispr8021X

Use this API command to create a new hotspot (WISPr) with 802.1X WLAN.

Request
HideShow
Body
‧ Sample : Create a Hotspot (WISPr) WLAN with default configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName",
        "authenticationOption" : null,
        "backupAuthenticationId" : "otherAuthServiceUUID",
        "backupAuthenticationOption" : null
    },
    "accountingServiceOrProfile" : {
        "id" : "acctingServiceUUID",
        "name" : "acctingServiceName",
        "throughController" : false,
        "realmBasedAcct" : false,
        "interimUpdateMin" : 10,
        "accountingDelayEnabled" : false,
        "backupAccountingId" : "otherAccountingServiceUUID",
        "backupAccountingName" : "otherAccountingServiceName"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    },
    "accessTunnelType" : "RuckusGRE",
    "accessTunnelProfile" : {
        "id" : "f5b92938-aa4e-4d02-90ea-273799ff689b",
        "name" : "Default Tunnel Profile"
    },
    "splitTunnelProfileId" : "38119bac-49e1-4410-ab8e-1c1bc88dd770",
    "coreTunnelProfile" : {
        "type" : "Bridge",
        "id" : "forwardingUUID",
        "name" : "forwardingName"
    },
    "encryption" : {
        "method" : "WPA2",
        "algorithm" : "AES",
        "passphrase" : "password",
        "mfp" : "disabled",
        "support80211rEnabled" : true,
        "mobilityDomainId" : 3
    },
    "operatorRealm" : "operator realm",
    "defaultUserTrafficProfile" : {
        "id" : "userTrafficUUID",
        "name" : "userTrafficName"
    },
    "precedenceProfileId" : "c514d450-c839-9527-afc9-525400d12345",
    "portalDetectionProfileId" : "de0fa30c-9565-11e8-9eb6-529269fb1459",
    "schedule" : {
        "type" : "Customized",
        "id" : "ServiceUUID",
        "name" : "ServiceName"
    },
    "vlan" : {
        "accessVlan" : 23,
        "coreQinQEnabled" : false,
        "coreSVlan" : 1,
        "vlanPooling" : null
    },
    "l2ACL" : {
        "id" : "l2ACLUUID",
        "name" : "l2ACLName"
    },
    "devicePolicy" : {
        "id" : "devicePolicyUUID",
        "name" : "devicePolicyName"
    },
    "radiusOptions" : {
        "nasIdType" : "Customized",
        "customizedNasId" : "nasId",
        "nasRequestTimeoutSec" : 12,
        "nasMaxRetry" : 3,
        "nasReconnectPrimaryMin" : 30,
        "calledStaIdType" : "WLAN_BSSID",
        "nasIpType" : "disabled",
        "nasIpUserDefined" : "192.168.1.1",
        "vendorSpecificAttributeProfileId" : "6d767421-d1b7-11e8-8ab9-ba2343155a93"
    },
    "firewallProfileId" : "c514d450-c839-9527-afc9-525400d12345",
    "firewallWlanSpecificEnabled" : true,
    "firewallUplinkRateLimitingMbps" : 20,
    "firewallDownlinkRateLimitingMbps" : 35,
    "firewallL3AccessControlPolicyId" : "6d32d2c5-2edf-443e-915f-4e582fd73355",
    "firewallL2AccessControlPolicyId" : "839f87c6-d116-497e-afce-aa8157abd30c",
    "firewallAppPolicyId" : "ae6f9c41-4c8a-4ac7-923a-22e9057c70d8",
    "firewallUrlFilteringPolicyId" : "dbbcdebb-8270-cbdc-ae24-3cda35530503",
    "firewallDevicePolicyId" : "fe10ea25-a32e-4824-8b3a-47320180e1a0",
    "wifiAgileMultibandEnabled" : false,
    "apHostNameAdvertisementEnabled" : false,
    "advancedOptions" : {
        "clientIsolationEnabled" : true,
        "clientIsolationUnicastEnabled" : true,
        "clientIsolationMulticastEnabled" : false,
        "clientIsolationAutoVrrpEnabled" : false,
        "clientIsolationWhitelist" : {
            "id" : "b89323e1-3168-11e7-b027-5254009ae3f0",
            "name" : "myWhitelist"
        },
        "priority" : "High",
        "hideSsidEnabled" : true,
        "maxClientsPerRadio" : 12,
        "wifi6Enabled" : true,
        "clientIdleTimeoutSec" : 60,
        "userSessionTimeout" : 172800,
        "clientLoadBalancingEnabled" : true,
        "proxyARPEnabled" : true,
        "ndProxyEnabled" : false,
        "suppressNsEnabled" : false,
        "raProxyEnabled" : false,
        "rsraGuardEnabled" : false,
        "raThrottlingEnabled" : false,
        "maxAllowedRA" : 10,
        "raInterval" : 10,
        "support80211dEnabled" : false,
        "support80211kEnabled" : true,
        "forceClientDHCPTimeoutSec" : 5,
        "dhcp82SubOpt1Format" : "SUBOPT1_AP_INFO_LOCATION",
        "unauthClientStatsEnabled" : false,
        "clientFingerprintingEnabled" : true,
        "multicastFilterDrop" : false,
        "ofdmOnlyEnabled" : false,
        "bandBalancing" : "UseZoneSetting",
        "bssMinRateMbps" : "Disable",
        "mgmtTxRateMbps" : "2 mbps",
        "avcEnabled" : true,
        "urlFilteringPolicyEnabled" : false,
        "urlFilteringPolicyId" : "",
        "wifiCallingPolicyEnabled" : false,
        "wifiCallingPolicyIds" : [ ],
        "uplinkEnabled" : true,
        "uplinkRate" : 100,
        "downlinkEnabled" : true,
        "downlinkRate" : 200,
        "multicastUplinkRateLimitEnabled" : true,
        "multicastUplinkRateLimit" : 10,
        "multicastDownlinkRateLimitEnabled" : true,
        "multicastDownlinkRateLimit" : 20,
        "multicastUplinkRateLimit6gEnabled" : true,
        "multicastDownlinkRateLimit6gEnabled" : true,
        "ratePerSTAUplink" : "650mbps",
        "ratePerSTADownlink" : "1mbps",
        "dnsSpoofingProfileId" : "b7ef88c1-22e3-11e9-8743-d29f54e2dacd",
        "vlanNameProfileId" : "1aef0e54-b0dd-4285-8916-ac8730f14276"
    },
    "diffServProfile" : {
        "id" : "diffServId",
        "name" : "diffServName"
    },
    "qosMaps" : [ {
        "enable" : true,
        "priority" : 0,
        "low" : 0,
        "high" : 7,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 1,
        "low" : 8,
        "high" : 15,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 2,
        "low" : 16,
        "high" : 23,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 3,
        "low" : 0,
        "high" : 32,
        "excepts" : [ 43, 45, 60 ]
    }, {
        "enable" : true,
        "priority" : 4,
        "low" : 32,
        "high" : 39,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 5,
        "low" : 40,
        "high" : 47,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 6,
        "low" : 48,
        "high" : 55,
        "excepts" : [ 46 ]
    }, {
        "enable" : true,
        "priority" : 7,
        "low" : 56,
        "high" : 63,
        "excepts" : null
    } ],
    "dnsServerProfile" : {
        "id" : "DNS server profile UUID",
        "name" : "DNS server profile name"
    },
    "dpsk" : {
        "dpskEnabled" : false,
        "length" : 8,
        "dpskType" : "Secure",
        "expiration" : "OneDay",
        "dpskFromType" : "FirstUse"
    },
    "externalDpsk" : {
        "enabled" : true,
        "encryption" : {
            "method" : "WPA2",
            "algorithm" : "AES",
            "mfp" : "disabled"
        },
        "authService" : {
            "id" : "authServiceUUID"
        }
    }
}
‧ Sample : Create a Hotspot (WISPr) WLAN allows Hotspot 2.0 Onboarding
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    },
    "advancedOptions" : {
        "hs20Onboarding" : true
    }
}
‧ Sample : Create a Hotspot (WISPr) WLAN with authenticationOption configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : true,
        "authenticationOption" : "Local DB",
        "backupAuthenticationId" : "otherAuthServiceUUID",
        "backupAuthenticationOption" : null
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean",
            "default" : false
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "portalServiceProfile" : {
            "description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean",
            "default" : false
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094,
                    "default" : 1
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                    "default" : "WLAN_BSSID"
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{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",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ],
                    "default" : "WLAN_BSSID"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ],
                    "default" : "High"
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean",
                    "default" : false
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "default" : 100,
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400,
                    "default" : 120
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000,
                    "default" : 172800
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "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. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean",
                    "default" : false
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean",
                    "default" : false
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "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",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ],
                    "default" : "UseZoneSetting"
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "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" ],
                    "default" : "2 mbps"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60",
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600,
                            "default" : 30
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ],
                            "default" : "ALL"
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean",
            "default" : false
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean",
            "default" : false
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Wechat

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

Use this API command to create a new wechat WLAN.

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "portalServiceProfile": {
    "id": "portalServiceUUID",
    "name": "portalServiceName"
  },
  "accessTunnelType": "RuckusGRE",
  "accessTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "encryption": {
    "method": "None"
  },
  "operatorRealm": "operator realm",
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "coreQinQEnabled": false,
    "coreSVlan": 1,
    "vlanPooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "firewallProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "firewallWlanSpecificEnabled": true,
  "firewallUplinkRateLimitingMbps": 20,
  "firewallDownlinkRateLimitingMbps": 35,
  "firewallL3AccessControlPolicyId": "6d32d2c5-2edf-443e-915f-4e582fd73355",
  "firewallL2AccessControlPolicyId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "firewallAppPolicyId": "ae6f9c41-4c8a-4ac7-923a-22e9057c70d8",
  "firewallUrlFilteringPolicyId": "dbbcdebb-8270-cbdc-ae24-3cda35530503",
  "firewallDevicePolicyId": "fe10ea25-a32e-4824-8b3a-47320180e1a0",
  "wifiAgileMultibandEnabled": false,
  "apHostNameAdvertisementEnabled": false,
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "b89323e1-3168-11e7-b027-5254009ae3f0",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 60,
    "wifi6Enabled": true,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "ndProxyEnabled": false,
    "suppressNsEnabled": false,
    "raProxyEnabled": false,
    "rsraGuardEnabled": false,
    "raThrottlingEnabled": false,
    "maxAllowedRA": 10,
    "raInterval": 10,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "multicastFilterDrop": false,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "urlFilteringPolicyEnabled": false,
    "urlFilteringPolicyId": "",
    "wifiCallingPolicyEnabled": false,
    "wifiCallingPolicyIds": [],
    "uplinkEnabled": true,
    "uplinkRate": 100,
    "downlinkEnabled": true,
    "downlinkRate": 200,
    "multicastUplinkRateLimitEnabled": true,
    "multicastUplinkRateLimit": 10,
    "multicastDownlinkRateLimitEnabled": true,
    "multicastDownlinkRateLimit": 20,
    "multicastUplinkRateLimit6gEnabled": true,
    "multicastDownlinkRateLimit6gEnabled": true,
    "ratePerSTAUplink": "650mbps",
    "ratePerSTADownlink": "1mbps",
    "dnsSpoofingProfileId": "b7ef88c1-22e3-11e9-8743-d29f54e2dacd",
    "vlanNameProfileId": "1aef0e54-b0dd-4285-8916-ac8730f14276"
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dnsServerProfile": {
    "id": "DNS server profile UUID",
    "name": "DNS server profile name"
  },
  "dpsk": {
    "dpskEnabled": false,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES",
      "mfp": "disabled"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "portalServiceProfile" : {
            "description" : "Wechat portal service of the WLAN. The ID or name of the wechat portal services within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean",
            "default" : false
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094,
                    "default" : 1
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                    "default" : "WLAN_BSSID"
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{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",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ],
                    "default" : "WLAN_BSSID"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ],
                    "default" : "High"
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean",
                    "default" : false
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "default" : 100,
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400,
                    "default" : 120
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000,
                    "default" : 172800
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "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. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean",
                    "default" : false
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean",
                    "default" : false
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "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",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ],
                    "default" : "UseZoneSetting"
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "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" ],
                    "default" : "2 mbps"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60",
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600,
                            "default" : 30
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ],
                            "default" : "ALL"
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean",
            "default" : false
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean",
            "default" : false
        }
    },
    "required" : [ "name", "ssid", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Guest Access

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

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

Request
HideShow
Body
‧ Sample : Create a Guest WLAN with default configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName",
        "authenticationOption" : null
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    },
    "accessTunnelType" : "RuckusGRE",
    "accessTunnelProfile" : {
        "id" : "f5b92938-aa4e-4d02-90ea-273799ff689b",
        "name" : "Default Tunnel Profile"
    },
    "splitTunnelProfileId" : "38119bac-49e1-4410-ab8e-1c1bc88dd770",
    "coreTunnelProfile" : {
        "type" : "Bridge",
        "id" : "forwardingUUID",
        "name" : "forwardingName"
    },
    "encryption" : {
        "method" : "WPA2",
        "algorithm" : "AES",
        "passphrase" : "password",
        "mfp" : "disabled",
        "support80211rEnabled" : true,
        "mobilityDomainId" : 3
    },
    "operatorRealm" : "operator realm",
    "defaultUserTrafficProfile" : {
        "id" : "userTrafficUUID",
        "name" : "userTrafficName"
    },
    "precedenceProfileId" : "c514d450-c839-9527-afc9-525400d12345",
    "socialMediaLoginProfileId" : "k513d150-j839-8123-anc8-525400d12366",
    "portalDetectionProfileId" : "de0fa30c-9565-11e8-9eb6-529269fb1459",
    "schedule" : {
        "type" : "Customized",
        "id" : "ServiceUUID",
        "name" : "ServiceName"
    },
    "vlan" : {
        "accessVlan" : 23,
        "coreQinQEnabled" : false,
        "coreSVlan" : 1,
        "vlanPooling" : null
    },
    "l2ACL" : {
        "id" : "l2ACLUUID",
        "name" : "l2ACLName"
    },
    "radiusOptions" : {
        "nasIdType" : "Customized",
        "customizedNasId" : "nasId",
        "nasRequestTimeoutSec" : 12,
        "nasMaxRetry" : 3,
        "nasReconnectPrimaryMin" : 30,
        "calledStaIdType" : "WLAN_BSSID",
        "nasIpType" : "disabled",
        "nasIpUserDefined" : "192.168.1.1",
        "vendorSpecificAttributeProfileId" : "6d767421-d1b7-11e8-8ab9-ba2343155a93"
    },
    "firewallProfileId" : "c514d450-c839-9527-afc9-525400d12345",
    "firewallWlanSpecificEnabled" : true,
    "firewallUplinkRateLimitingMbps" : 20,
    "firewallDownlinkRateLimitingMbps" : 35,
    "firewallL3AccessControlPolicyId" : "6d32d2c5-2edf-443e-915f-4e582fd73355",
    "firewallL2AccessControlPolicyId" : "839f87c6-d116-497e-afce-aa8157abd30c",
    "firewallAppPolicyId" : "ae6f9c41-4c8a-4ac7-923a-22e9057c70d8",
    "firewallUrlFilteringPolicyId" : "dbbcdebb-8270-cbdc-ae24-3cda35530503",
    "firewallDevicePolicyId" : "fe10ea25-a32e-4824-8b3a-47320180e1a0",
    "wifiAgileMultibandEnabled" : false,
    "apHostNameAdvertisementEnabled" : false,
    "advancedOptions" : {
        "clientIsolationEnabled" : true,
        "clientIsolationUnicastEnabled" : true,
        "clientIsolationMulticastEnabled" : false,
        "clientIsolationAutoVrrpEnabled" : false,
        "clientIsolationWhitelist" : {
            "id" : "b89323e1-3168-11e7-b027-5254009ae3f0",
            "name" : "myWhitelist"
        },
        "priority" : "High",
        "hideSsidEnabled" : true,
        "maxClientsPerRadio" : 12,
        "clientIdleTimeoutSec" : 60,
        "wifi6Enabled" : true,
        "clientLoadBalancingEnabled" : true,
        "proxyARPEnabled" : true,
        "ndProxyEnabled" : false,
        "suppressNsEnabled" : false,
        "raProxyEnabled" : false,
        "rsraGuardEnabled" : false,
        "raThrottlingEnabled" : false,
        "maxAllowedRA" : 10,
        "raInterval" : 10,
        "support80211dEnabled" : false,
        "support80211kEnabled" : true,
        "forceClientDHCPTimeoutSec" : 5,
        "dhcp82SubOpt1Format" : "SUBOPT1_AP_INFO_LOCATION",
        "unauthClientStatsEnabled" : false,
        "clientFingerprintingEnabled" : true,
        "multicastFilterDrop" : false,
        "ofdmOnlyEnabled" : false,
        "bandBalancing" : "UseZoneSetting",
        "bssMinRateMbps" : "Disable",
        "mgmtTxRateMbps" : "2 mbps",
        "avcEnabled" : true,
        "urlFilteringPolicyEnabled" : false,
        "urlFilteringPolicyId" : "",
        "wifiCallingPolicyEnabled" : false,
        "wifiCallingPolicyIds" : [ ],
        "uplinkEnabled" : true,
        "uplinkRate" : 100,
        "downlinkEnabled" : true,
        "downlinkRate" : 200,
        "multicastUplinkRateLimitEnabled" : true,
        "multicastUplinkRateLimit" : 10,
        "multicastDownlinkRateLimitEnabled" : true,
        "multicastDownlinkRateLimit" : 20,
        "multicastUplinkRateLimit6gEnabled" : true,
        "multicastDownlinkRateLimit6gEnabled" : true,
        "ratePerSTAUplink" : "650mbps",
        "ratePerSTADownlink" : "1mbps",
        "dnsSpoofingProfileId" : "b7ef88c1-22e3-11e9-8743-d29f54e2dacd",
        "vlanNameProfileId" : "1aef0e54-b0dd-4285-8916-ac8730f14276"
    },
    "diffServProfile" : {
        "id" : "diffServId",
        "name" : "diffServName"
    },
    "qosMaps" : [ {
        "enable" : true,
        "priority" : 0,
        "low" : 0,
        "high" : 7,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 1,
        "low" : 8,
        "high" : 15,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 2,
        "low" : 16,
        "high" : 23,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 3,
        "low" : 0,
        "high" : 32,
        "excepts" : [ 43, 45, 60 ]
    }, {
        "enable" : true,
        "priority" : 4,
        "low" : 32,
        "high" : 39,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 5,
        "low" : 40,
        "high" : 47,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 6,
        "low" : 48,
        "high" : 55,
        "excepts" : [ 46 ]
    }, {
        "enable" : true,
        "priority" : 7,
        "low" : 56,
        "high" : 63,
        "excepts" : null
    } ],
    "dnsServerProfile" : {
        "id" : "DNS server profile UUID",
        "name" : "DNS server profile name"
    },
    "dpsk" : {
        "dpskEnabled" : false,
        "length" : 8,
        "dpskType" : "Secure",
        "expiration" : "OneDay",
        "dpskFromType" : "FirstUse"
    },
    "externalDpsk" : {
        "enabled" : true,
        "encryption" : {
            "method" : "WPA2",
            "algorithm" : "AES",
            "mfp" : "disabled"
        },
        "authService" : {
            "id" : "authServiceUUID"
        }
    }
}
‧ Sample : Create a Guest WLAN with authenticationOption configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : true,
        "authenticationOption" : "Guest"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean",
            "default" : false
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. Guest WLANs only accept two names: Local DB and Always Accept.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "portalServiceProfile" : {
            "description" : "Guest portal service of the WLAN. The ID or name of the guest portal services within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean",
            "default" : false
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "socialMediaLoginProfileId" : {
            "type" : "string"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094,
                    "default" : 1
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                    "default" : "WLAN_BSSID"
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{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",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ],
                    "default" : "WLAN_BSSID"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ],
                    "default" : "High"
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean",
                    "default" : false
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "default" : 100,
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400,
                    "default" : 120
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000,
                    "default" : 172800
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "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. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean",
                    "default" : false
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean",
                    "default" : false
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "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",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ],
                    "default" : "UseZoneSetting"
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "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" ],
                    "default" : "2 mbps"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60",
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600,
                            "default" : 30
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ],
                            "default" : "ALL"
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean",
            "default" : false
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean",
            "default" : false
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Web Auth

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

Use this API command to creates new web authentication WLAN.

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "authServiceOrProfile": {
    "throughController": false,
    "id": "authServiceUUID",
    "name": "authServiceName",
    "authenticationOption": null
  },
  "portalServiceProfile": {
    "id": "portalServiceUUID",
    "name": "portalServiceName"
  },
  "accessTunnelType": "RuckusGRE",
  "accessTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "passphrase": "password",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "operatorRealm": "operator realm",
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "coreQinQEnabled": false,
    "coreSVlan": 1,
    "vlanPooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "firewallProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "firewallWlanSpecificEnabled": true,
  "firewallUplinkRateLimitingMbps": 20,
  "firewallDownlinkRateLimitingMbps": 35,
  "firewallL3AccessControlPolicyId": "6d32d2c5-2edf-443e-915f-4e582fd73355",
  "firewallL2AccessControlPolicyId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "firewallAppPolicyId": "ae6f9c41-4c8a-4ac7-923a-22e9057c70d8",
  "firewallUrlFilteringPolicyId": "dbbcdebb-8270-cbdc-ae24-3cda35530503",
  "firewallDevicePolicyId": "fe10ea25-a32e-4824-8b3a-47320180e1a0",
  "wifiAgileMultibandEnabled": false,
  "apHostNameAdvertisementEnabled": false,
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "b89323e1-3168-11e7-b027-5254009ae3f0",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 60,
    "wifi6Enabled": true,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "ndProxyEnabled": false,
    "suppressNsEnabled": false,
    "raProxyEnabled": false,
    "rsraGuardEnabled": false,
    "raThrottlingEnabled": false,
    "maxAllowedRA": 10,
    "raInterval": 10,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "multicastFilterDrop": false,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "urlFilteringPolicyEnabled": false,
    "urlFilteringPolicyId": "",
    "wifiCallingPolicyEnabled": false,
    "wifiCallingPolicyIds": [],
    "uplinkEnabled": true,
    "uplinkRate": 100,
    "downlinkEnabled": true,
    "downlinkRate": 200,
    "multicastUplinkRateLimitEnabled": true,
    "multicastUplinkRateLimit": 10,
    "multicastDownlinkRateLimitEnabled": true,
    "multicastDownlinkRateLimit": 20,
    "multicastUplinkRateLimit6gEnabled": true,
    "multicastDownlinkRateLimit6gEnabled": true,
    "ratePerSTAUplink": "650mbps",
    "ratePerSTADownlink": "1mbps",
    "dnsSpoofingProfileId": "b7ef88c1-22e3-11e9-8743-d29f54e2dacd",
    "vlanNameProfileId": "1aef0e54-b0dd-4285-8916-ac8730f14276"
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dnsServerProfile": {
    "id": "DNS server profile UUID",
    "name": "DNS server profile name"
  },
  "dpsk": {
    "dpskEnabled": false,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES",
      "mfp": "disabled"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean",
            "default" : false
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "portalServiceProfile" : {
            "description" : "Web authorizationn portal service of the WLAN. The ID or name of the guest portal services within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean",
            "default" : false
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094,
                    "default" : 1
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                    "default" : "WLAN_BSSID"
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{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",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ],
                    "default" : "WLAN_BSSID"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ],
                    "default" : "High"
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean",
                    "default" : false
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "default" : 100,
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400,
                    "default" : 120
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000,
                    "default" : 172800
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "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. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean",
                    "default" : false
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean",
                    "default" : false
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "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",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ],
                    "default" : "UseZoneSetting"
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "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" ],
                    "default" : "2 mbps"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60",
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600,
                            "default" : 30
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ],
                            "default" : "ALL"
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean",
            "default" : false
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean",
            "default" : false
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot 2.0

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

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

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "hotspot20Profile": {
    "id": "hotspot20ServiceUUID",
    "name": "hotspot20ServiceName"
  },
  "accessTunnelType": "RuckusGRE",
  "accessTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "operatorRealm": "operator realm",
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "aaaVlanOverride": true,
    "coreQinQEnabled": false,
    "coreSVlan": 1,
    "vlanPooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "firewallProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "firewallWlanSpecificEnabled": true,
  "firewallUplinkRateLimitingMbps": 20,
  "firewallDownlinkRateLimitingMbps": 35,
  "firewallL3AccessControlPolicyId": "6d32d2c5-2edf-443e-915f-4e582fd73355",
  "firewallL2AccessControlPolicyId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "firewallAppPolicyId": "ae6f9c41-4c8a-4ac7-923a-22e9057c70d8",
  "firewallUrlFilteringPolicyId": "dbbcdebb-8270-cbdc-ae24-3cda35530503",
  "firewallDevicePolicyId": "fe10ea25-a32e-4824-8b3a-47320180e1a0",
  "wifiAgileMultibandEnabled": false,
  "apHostNameAdvertisementEnabled": false,
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "b89323e1-3168-11e7-b027-5254009ae3f0",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 60,
    "wifi6Enabled": true,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "ndProxyEnabled": false,
    "suppressNsEnabled": false,
    "raProxyEnabled": false,
    "rsraGuardEnabled": false,
    "raThrottlingEnabled": false,
    "maxAllowedRA": 10,
    "raInterval": 10,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "multicastFilterDrop": false,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "urlFilteringPolicyEnabled": false,
    "urlFilteringPolicyId": "",
    "wifiCallingPolicyEnabled": false,
    "wifiCallingPolicyIds": [],
    "uplinkEnabled": true,
    "uplinkRate": 100,
    "downlinkEnabled": true,
    "downlinkRate": 200,
    "multicastUplinkRateLimitEnabled": true,
    "multicastUplinkRateLimit": 10,
    "multicastDownlinkRateLimitEnabled": true,
    "multicastDownlinkRateLimit": 20,
    "multicastUplinkRateLimit6gEnabled": true,
    "multicastDownlinkRateLimit6gEnabled": true,
    "ratePerSTAUplink": "650mbps",
    "ratePerSTADownlink": "1mbps"
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dnsServerProfile": {
    "id": "DNS server profile UUID",
    "name": "DNS server profile name"
  },
  "dpsk": {
    "dpskEnabled": false,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES",
      "mfp": "disabled"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. The ID or name of the Hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean",
            "default" : false
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094,
                    "default" : 1
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                    "default" : "WLAN_BSSID"
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{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",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ],
                    "default" : "WLAN_BSSID"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ],
                    "default" : "High"
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean",
                    "default" : false
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "default" : 100,
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400,
                    "default" : 120
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000,
                    "default" : 172800
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "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. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean",
                    "default" : false
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean",
                    "default" : false
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "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",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ],
                    "default" : "UseZoneSetting"
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "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" ],
                    "default" : "2 mbps"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60",
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600,
                            "default" : 30
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ],
                            "default" : "ALL"
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean",
            "default" : false
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean",
            "default" : false
        }
    },
    "required" : [ "name", "ssid", "hotspot20Profile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot 2.0 Open

POST/v11_1/rkszones/{zoneId}/wlans/hotspot20open

Use this API command to create a new Hotspot 2.0 Onboarding WLAN with Authentication Method as ‘Open’.

Request
HideShow
Body
{
  "name": "api-test-wlanhs20open",
  "ssid": "api-test-wlanhs20open",
  "description": "wlanDescription"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean",
            "default" : false
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094,
                    "default" : 1
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                    "default" : "WLAN_BSSID"
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{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",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ],
                    "default" : "WLAN_BSSID"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ],
                    "default" : "High"
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean",
                    "default" : false
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "default" : 100,
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400,
                    "default" : 120
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000,
                    "default" : 172800
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "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. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean",
                    "default" : false
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean",
                    "default" : false
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "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",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ],
                    "default" : "UseZoneSetting"
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "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" ],
                    "default" : "2 mbps"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60",
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600,
                            "default" : 30
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ],
                            "default" : "ALL"
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean",
            "default" : false
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean",
            "default" : false
        }
    },
    "required" : [ "name", "ssid" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot 2.0 OSEN

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

Use this API command to create a new Hotspot 2.0 Onboarding WLAN with Authentication Method as ‘802.1X’.

Request
HideShow
Body
{
  "name": "api-test-wlanhs20open",
  "ssid": "api-test-wlanhs20open",
  "description": "wlanDescription"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean",
            "default" : false
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094,
                    "default" : 1
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
                    "default" : "WLAN_BSSID"
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{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",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ],
                    "default" : "WLAN_BSSID"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ],
                    "default" : "High"
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean",
                    "default" : false
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "default" : 100,
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400,
                    "default" : 120
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000,
                    "default" : 172800
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "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. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean",
                    "default" : false
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean",
                    "default" : false
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "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",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ],
                    "default" : "UseZoneSetting"
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "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" ],
                    "default" : "2 mbps"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60",
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600,
                            "default" : 30
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ],
                            "default" : "ALL"
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean",
            "default" : false
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean",
            "default" : false
        }
    },
    "required" : [ "name", "ssid" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Enable Qos Map Set

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

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

Response  201

Modify Entire

PUT/v11_1/rkszones/{zoneId}/wlans/{id}

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

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "accessTunnelType": "RuckusGRE",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "macAuth": {
    "macAuthMacFormat": "802.1X",
    "customizedPassword": "password"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "passphrase": "password",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "authServiceOrProfile": {
    "throughController": true,
    "id": "authServiceUUID",
    "locationDeliveryEnabled": true,
    "authenticationOption": null
  },
  "operatorRealm": "operator realm",
  "accountingServiceOrProfile": {
    "throughController": false,
    "id": "accountingServiceUUID",
    "name": "accountingServiceName",
    "interimUpdateMin": 10,
    "accountingDelayEnabled": false,
    "accountingTTGSessionEnabled": false,
    "backupAccountingId": "otherAccountingServiceUUID",
    "backupAccountingName": "otherAccountingServiceName"
  },
  "portalServiceProfile": {
    "id": "portalServiceUUID",
    "name": "portalServiceName"
  },
  "hotspot20Profile": {
    "id": "hotspot20ServiceUUID",
    "name": "hotspot20ServiceName"
  },
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "paloAltoFirewallProfileOverrided": true,
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "aaaVlanOverride": true,
    "vlanpooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "singleSessionIdAcctEnabled": false,
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "firewallProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "firewallWlanSpecificEnabled": true,
  "firewallUplinkRateLimitingMbps": 20,
  "firewallDownlinkRateLimitingMbps": 35,
  "firewallL3AccessControlPolicyId": "6d32d2c5-2edf-443e-915f-4e582fd73355",
  "firewallL2AccessControlPolicyId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "firewallAppPolicyId": "ae6f9c41-4c8a-4ac7-923a-22e9057c70d8",
  "firewallUrlFilteringPolicyId": "dbbcdebb-8270-cbdc-ae24-3cda35530503",
  "firewallDevicePolicyId": "fe10ea25-a32e-4824-8b3a-47320180e1a0",
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 12,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "antiSpoofingEnabled": true,
    "arpRequestRateLimit": 15,
    "dhcpRequestRateLimit": 15,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "multicastFilterDrop": false,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "uplinkEnabled": false,
    "downlinkEnabled": false,
    "hs20Onboarding": false,
    "avcEnabled": true,
    "dtimInterval": 1,
    "directedThreshold": 5,
    "multicastUplinkRateLimitEnabled": true,
    "multicastUplinkRateLimit": 10,
    "multicastDownlinkRateLimitEnabled": true,
    "multicastDownlinkRateLimit": 20,
    "urlFilteringPolicyEnabled": false,
    "urlFilteringPolicyId": "",
    "wifiCallingPolicyEnabled": false,
    "wifiCallingPolicyIds": [],
    "hdOverheadOptimizeEnable": false,
    "probeRssiThr": -85,
    "transientClientMgmtEnable": true,
    "joinIgnoreTimeout": 30,
    "joinAcceptTimeout": 300,
    "joinIgnoreThr": 10,
    "dropRandomProbesEnabled": true,
    "authRssiThr": -85,
    "assocRssiThr": -85
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dpsk": {
    "dpskEnabled": true,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean"
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean"
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "socialMediaLoginProfileId" : {
            "type" : "string"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                },
                "nasRequestTimeoutSec" : {
                    "description" : "NAS request timeout in seconds",
                    "type" : "integer",
                    "minimum" : 2,
                    "maximum" : 20
                },
                "nasMaxRetry" : {
                    "description" : "NAS request maximum retry",
                    "type" : "integer",
                    "minimum" : 2,
                    "maximum" : 10
                },
                "nasReconnectPrimaryMin" : {
                    "description" : "NAS reconnect primary time in minutes",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60
                },
                "calledStaIdType" : {
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ]
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ]
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean"
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean"
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean"
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean"
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean"
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean"
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean"
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean"
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean"
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "dhcpOption82Enabled" : {
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "type" : "boolean"
                },
                "ofdmOnlyEnabled" : {
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean"
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean"
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean"
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean"
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean"
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60"
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean"
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean"
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean"
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean"
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean"
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ]
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean"
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer"
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ]
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean"
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean"
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean"
        }
    }
}
Response  204

Modify

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

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

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "accessTunnelType": "RuckusGRE",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "macAuth": {
    "macAuthMacFormat": "802.1X",
    "customizedPassword": "password"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "passphrase": "password",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "authServiceOrProfile": {
    "throughController": true,
    "id": "authServiceUUID",
    "locationDeliveryEnabled": true,
    "authenticationOption": null
  },
  "operatorRealm": "operator realm",
  "accountingServiceOrProfile": {
    "throughController": false,
    "id": "accountingServiceUUID",
    "name": "accountingServiceName",
    "interimUpdateMin": 10,
    "accountingDelayEnabled": false,
    "accountingTTGSessionEnabled": false,
    "backupAccountingId": "otherAccountingServiceUUID",
    "backupAccountingName": "otherAccountingServiceName"
  },
  "portalServiceProfile": {
    "id": "portalServiceUUID",
    "name": "portalServiceName"
  },
  "hotspot20Profile": {
    "id": "hotspot20ServiceUUID",
    "name": "hotspot20ServiceName"
  },
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "paloAltoFirewallProfileOverrided": true,
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "aaaVlanOverride": true,
    "vlanpooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "singleSessionIdAcctEnabled": false,
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "firewallProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "firewallWlanSpecificEnabled": true,
  "firewallUplinkRateLimitingMbps": 20,
  "firewallDownlinkRateLimitingMbps": 35,
  "firewallL3AccessControlPolicyId": "6d32d2c5-2edf-443e-915f-4e582fd73355",
  "firewallL2AccessControlPolicyId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "firewallAppPolicyId": "ae6f9c41-4c8a-4ac7-923a-22e9057c70d8",
  "firewallUrlFilteringPolicyId": "dbbcdebb-8270-cbdc-ae24-3cda35530503",
  "firewallDevicePolicyId": "fe10ea25-a32e-4824-8b3a-47320180e1a0",
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 12,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "antiSpoofingEnabled": true,
    "arpRequestRateLimit": 15,
    "dhcpRequestRateLimit": 15,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "multicastFilterDrop": false,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "uplinkEnabled": false,
    "downlinkEnabled": false,
    "hs20Onboarding": false,
    "avcEnabled": true,
    "dtimInterval": 1,
    "directedThreshold": 5,
    "multicastUplinkRateLimitEnabled": true,
    "multicastUplinkRateLimit": 10,
    "multicastDownlinkRateLimitEnabled": true,
    "multicastDownlinkRateLimit": 20,
    "urlFilteringPolicyEnabled": false,
    "urlFilteringPolicyId": "",
    "wifiCallingPolicyEnabled": false,
    "wifiCallingPolicyIds": [],
    "hdOverheadOptimizeEnable": false,
    "probeRssiThr": -85,
    "transientClientMgmtEnable": true,
    "joinIgnoreTimeout": 30,
    "joinAcceptTimeout": 300,
    "joinIgnoreThr": 10,
    "dropRandomProbesEnabled": true,
    "authRssiThr": -85,
    "assocRssiThr": -85
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dpsk": {
    "dpskEnabled": true,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean"
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                },
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None", "WPA3", "WPA23_Mixed", "OWE", "OWE_Transition" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES", "AES_GCMP_256" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "saePassphrase" : {
                    "description" : "saePassphrase. This only applies to WPA3 and WPA23 mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES or OWE method.",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "transitionDisable" : {
                    "description" : "When enabled, the wifi client connected to this Access Point should use the most secure algorithm that the client supports to associate with AP. This is available only when WPA3 and OWE (Enhanced Open) are configured.",
                    "type" : "boolean"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "reserveSsidEnabled" : {
                    "description" : "Enable Reserve SSID.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", "Local DB Social Media", "Social Media", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : [ "string", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 1440
                },
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "accountingTTGSessionEnabled" : {
                    "description" : "Indicates whether accounting for TTG sessions is to enabled",
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            }
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "firewallProfileId" : {
            "description" : "Firewall profile of the WLAN",
            "type" : "string"
        },
        "firewallWlanSpecificEnabled" : {
            "description" : "Firewall WLAN specific enabled",
            "type" : "boolean"
        },
        "firewallUplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallDownlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "firewallL3AccessControlPolicyId" : {
            "description" : "Firewall L3 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallL2AccessControlPolicyId" : {
            "description" : "Firewall L2 Access Control Policy of WLAN specific",
            "type" : "string"
        },
        "firewallAppPolicyId" : {
            "description" : "Firewall Application Policy of WLAN specific",
            "type" : "string"
        },
        "firewallUrlFilteringPolicyId" : {
            "description" : "Firewall Url Filtering Policy of WLAN specific",
            "type" : "string"
        },
        "firewallDevicePolicyId" : {
            "description" : "Firewall Device Policy of WLAN specific",
            "type" : "string"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "socialMediaLoginProfileId" : {
            "type" : "string"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            },
            "required" : [ "type" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 4094
                },
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                },
                "nasRequestTimeoutSec" : {
                    "description" : "NAS request timeout in seconds",
                    "type" : "integer",
                    "minimum" : 2,
                    "maximum" : 20
                },
                "nasMaxRetry" : {
                    "description" : "NAS request maximum retry",
                    "type" : "integer",
                    "minimum" : 2,
                    "maximum" : 10
                },
                "nasReconnectPrimaryMin" : {
                    "description" : "NAS reconnect primary time in minutes",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60
                },
                "calledStaIdType" : {
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "WLAN_BSSID", "AP_MAC", "NONE", "AP_GROUP", "AP_NAME" ]
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "userDefined" ]
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean"
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 512
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "type" : "integer",
                    "minimum" : 60,
                    "maximum" : 86400
                },
                "gtkRekeyEnabled" : {
                    "description" : "Indicates whether GTK rekey feature is enabled or disabled",
                    "type" : "boolean"
                },
                "wifi6Enabled" : {
                    "description" : "Indicates whether wifi6 feature is enabled or disabled",
                    "type" : "boolean"
                },
                "userSessionTimeout" : {
                    "description" : "User session timeout in seconds. This variable only support wlan types [\"standard8021X\", \"standard8021Xmac\", \"standardmac\", \"wisprmac\"]",
                    "type" : "integer",
                    "minimum" : 120,
                    "maximum" : 864000
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean"
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean"
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean"
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean"
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean"
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean"
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "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).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "dhcpOption82Enabled" : {
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID", "SUBOPT1_AP_MAC", "SUBOPT1_AP_MAC_ESSID", "SUBOPT1_AP_Name_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID", "SUBOPT2_AP_MAC_ESSID", "SUBOPT2_AP_Name" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "dhcp82MacFormat" : {
                    "description" : "AP and Client Mac format. If dhcpOption82Enabled is true, you have to set the dhcp82MacFormat [\"COLON\",\"HYPHEN\",\"NODELIMITER\"].",
                    "type" : "string",
                    "enum" : [ "COLON", "HYPHEN", "NODELIMITER" ]
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "multicastFilterDrop" : {
                    "description" : "Drop the broadcast/multicast packets from associated clients.",
                    "type" : "boolean"
                },
                "ofdmOnlyEnabled" : {
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "clientVirtualIdExtractionEnabled" : {
                    "type" : "boolean"
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean"
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "wifiCallingPolicyEnabled" : {
                    "description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
                    "type" : "boolean"
                },
                "wifiCallingPolicyIds" : {
                    "description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "multicastUplinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "multicastUplinkRateLimit" : {
                    "description" : "Multicast Rate Limiting uplink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastDownlinkRateLimitEnabled" : {
                    "description" : "Multicast Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit" : {
                    "description" : "Multicast Rate Limiting downlink (mbps).",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                },
                "multicastUplinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting uplink 6G enabled.",
                    "type" : "boolean"
                },
                "multicastDownlinkRateLimit6gEnabled" : {
                    "description" : "Multicast Rate Limiting downlink 6G enabled.",
                    "type" : "boolean"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean"
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime decongestion enabled.",
                    "type" : "boolean"
                },
                "probeRssiThr" : {
                    "type" : [ "integer", "null" ],
                    "description" : "Join RSSI threshold. Value should be 0 (disabled) or between -90 and -60"
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean"
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean"
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer"
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer"
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean"
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceReduceNeighborReportEnabled" : {
                    "description" : "Reduce Neighbor Report enabled.",
                    "type" : "boolean"
                },
                "oceApChannelReportEnabled" : {
                    "description" : "Ap Channel Report enabled.",
                    "type" : "boolean"
                },
                "fils" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "encryptionType" : {
                            "type" : "string",
                            "enum" : [ "SHA256", "SHA384" ]
                        },
                        "dhcpServerIp" : {
                            "type" : "string"
                        },
                        "hlpTimeout" : {
                            "type" : "integer",
                            "minimum" : 30,
                            "maximum" : 600
                        },
                        "realmProfileId" : {
                            "type" : "string"
                        }
                    },
                    "required" : [ "encryptionType", "dhcpServerIp" ]
                },
                "dnsSpoofingProfileId" : {
                    "description" : "DNS Spoofing Profile ID",
                    "type" : "string"
                },
                "vlanNameProfileId" : {
                    "type" : "string"
                },
                "userRoleAccess" : {
                    "description" : "Allow which user role can access this WLAN.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "allowedRoleOption" : {
                            "type" : "string",
                            "enum" : [ "ALL", "SPECIFIC" ]
                        },
                        "allowedSpecificRoles" : {
                            "type" : "array",
                            "items" : {
                                "type" : "string"
                            }
                        }
                    }
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean"
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer"
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ]
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean"
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        },
                        "mfp" : {
                            "description" : "Encryption mfp",
                            "type" : "string",
                            "enum" : [ "disabled", "capable", "required" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        },
        "wifiAgileMultibandEnabled" : {
            "description" : "Agile Multi-Band Enabled",
            "type" : "boolean"
        },
        "apHostNameAdvertisementEnabled" : {
            "description" : "AP Host Name Advertisement Enabled",
            "type" : "boolean"
        }
    }
}
Response  204

Delete

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

Use this API command to delete a WLAN.

Response  204

Disable Accounting

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

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

Response  204

Disable Layer 2 ACL

DELETE/v11_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

Disable Device Policy

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

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

Response  204

Disable DiffServ Profile

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

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

Response  204

Disable Qos Map Set

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

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

Response  204

Disable DNS server profile

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

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

Response  204

WLAN Scheduler

Retrieve

GET/v11_1/rkszones/{zoneId}/wlanSchedulers/{id}

Use this API command to retrieve a WLAN schedule.

Response  200
HideShow
Body
{
  "id": "wlanSchedulerUUID",
  "zoneId": "zoneUUID",
  "name": "wlanSchedulerName",
  "description": "wlanSchedulerDescription",
  "sun": [
    "00:15-01:15",
    "07:00-08:30",
    "10:45-12:00"
  ],
  "mon": [
    "00:00-01:15",
    "13:00-14:00"
  ],
  "tue": [
    "00:15-01:15"
  ],
  "wed": [
    "00:15-01:15",
    "07:00-08:30",
    "10:45-12:00"
  ],
  "thu": [
    "00:15-01:15"
  ],
  "fri": [
    "00:15-01:15"
  ],
  "sat": [
    "23:45-24:00"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the WLAN schedule",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone to which the WLAN schedule belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the WLAN schedule",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the WLAN schedule",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "sun": {
      "description": "Schedules on Sunday",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "mon": {
      "description": "Schedules on Monday",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tue": {
      "description": "Schedules on Tuesday",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "wed": {
      "description": "Schedules on Wednesday",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "thu": {
      "description": "Schedules on Thursday",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "fri": {
      "description": "Schedules on Friday",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sat": {
      "description": "Schedules on Saturday",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Retrieve List

GET/v11_1/rkszones/{zoneId}/wlanSchedulers

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

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "wlanSchedulerUUID",
      "name": "wlanSchedulerName",
      "description": "wlanSchedulerDescription",
      "sun": [
        "00:15-01:15",
        "07:00-08:30",
        "10:45-12:00"
      ],
      "mon": [
        "00:00-01:15",
        "13:00-14:00"
      ],
      "tue": [
        "00:15-01:15"
      ],
      "wed": [
        "00:15-01:15",
        "07:00-08:30",
        "10:45-12:00"
      ],
      "thu": [
        "00:15-01:15"
      ],
      "fri": [
        "00:15-01:15"
      ],
      "sat": [
        "23:45-24:00"
      ]
    },
    {
      "id": "wlanSchedulerUUID2",
      "name": "wlanSchedulerName2",
      "description": "wlanSchedulerDescription2",
      "sun": [
        "00:15-01:15",
        "07:00-08:30",
        "10:45-12:00"
      ],
      "mon": [
        "00:00-01:15",
        "13:00-14:00"
      ],
      "tue": [
        "00:15-01:15"
      ],
      "wed": [
        "00:15-01:15",
        "07:00-08:30",
        "10:45-12:00"
      ],
      "thu": [
        "16:15-17:15"
      ],
      "fri": [
        "00:30-03:15"
      ],
      "sat": [
        "23:45-24:00"
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the WLAN schedule",
            "type": "string"
          },
          "zoneId": {
            "description": "Identifier of the zone to which the WLAN schedule belongs",
            "type": "string"
          },
          "name": {
            "description": "Name of the WLAN schedule",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the WLAN schedule",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "sun": {
            "description": "Schedules on Sunday",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "mon": {
            "description": "Schedules on Monday",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "tue": {
            "description": "Schedules on Tuesday",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "wed": {
            "description": "Schedules on Wednesday",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "thu": {
            "description": "Schedules on Thursday",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "fri": {
            "description": "Schedules on Friday",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "sat": {
            "description": "Schedules on Saturday",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

Retrieve Wlan Scheduler List

POST/v11_1/query/services/wlanScheduler

Query Wlan Schedulers with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Create

POST/v11_1/rkszones/{zoneId}/wlanSchedulers

Use this API command to create a new WLAN schedule.

Request
HideShow
Body
{
  "name": "wlanSchedulerName",
  "description": "wlanSchedulerDescription",
  "sun": [
    "00:15-01:15",
    "07:00-08:30",
    "10:45-12:00"
  ],
  "mon": [
    "00:00-01:15",
    "13:00-14:00"
  ],
  "tue": [
    "00:15-01:15"
  ],
  "wed": [
    "00:15-01:15"
  ],
  "thu": [
    "00:15-01:15"
  ],
  "fri": [
    "00:15-01:15"
  ],
  "sat": [
    "23:45-24:00"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the WLAN schedule",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the WLAN schedule",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "sun": {
      "description": "Schedules on Sunday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "mon": {
      "description": "Schedules on Monday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "tue": {
      "description": "Schedules on Tuesday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "wed": {
      "description": "Schedules on Wednesday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "thu": {
      "description": "Schedules on Thursday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "fri": {
      "description": "Schedules on Friday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "sat": {
      "description": "Schedules on Saturday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": "wlanSchedulerUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

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

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

Request
HideShow
Body
{
  "name": "wlanSchedulerName",
  "description": "wlanSchedulerDescription",
  "sun": [
    "00:15-01:15",
    "07:00-08:30",
    "10:45-12:00"
  ],
  "mon": [
    "00:00-01:15",
    "13:00-14:00"
  ],
  "tue": [
    "00:15-01:15"
  ],
  "wed": [
    "00:15-01:15",
    "07:00-08:30",
    "10:45-12:00"
  ],
  "thu": [
    "00:15-01:15"
  ],
  "fri": [
    "00:15-01:15"
  ],
  "sat": [
    "23:45-24:00"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the WLAN schedule",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the WLAN schedule",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "sun": {
      "description": "Schedules on Sunday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "mon": {
      "description": "Schedules on Monday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "tue": {
      "description": "Schedules on Tuesday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "wed": {
      "description": "schedules on Wednesday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "thu": {
      "description": "Schedules on Thursday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "fri": {
      "description": "Schedules on Friday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "sat": {
      "description": "Schedules on Saturday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    }
  }
}
Response  204

Delete

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

Use this API command to delete a WLAN schedule.

Response  204

Zone Schedule Upgrade

Retrieve Zone Firmware Schedule Upgrade History

GET/v11_1/zoneScheduleUpgrade/history

Retrieve Zone Firmware Schedule Upgrade History

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "taskName": "upgradeTask",
      "scheduleTime": 1620576000000,
      "targetVersion": "6.1.0.0.80",
      "zoneList": [
        {
          "id": "6887d5f2-60af-4b0b-8294-f0d523df8e84",
          "name": "upgradeTask"
        }
      ],
      "errorLog": ""
    }
  ]
}
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": {
            "type": "string"
          },
          "taskName": {
            "description": "Task name",
            "type": "string"
          },
          "scheduleTime": {
            "description": "Schedule time in millisecond timestamp",
            "type": "integer"
          },
          "targetVersion": {
            "description": "Target version of the firmware upgrade or downgrade process",
            "type": "string"
          },
          "zoneList": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                }
              }
            }
          },
          "errorLog": {
            "description": "Error log of schedule upgrade process",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve Zone Firmware Schedule Upgrade Task List

GET/v11_1/zoneScheduleUpgrade

Retrieve Zone Firmware Schedule Upgrade Task List

Response  200
HideShow
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": {
            "type": "string"
          },
          "taskName": {
            "description": "Task name",
            "type": "string"
          },
          "scheduleTime": {
            "description": "Schedule time in millisecond timestamp, task will be process in every halt hour (exp: 1:00, 1:30 ...)",
            "type": "integer"
          },
          "targetVersion": {
            "description": "Target version of the firmware upgrade or downgrade process",
            "type": "string"
          },
          "status": {
            "description": "The task process status",
            "type": "string",
            "enum": [
              "PENDING",
              "IN_PROGRESS",
              "EXECUTED",
              "QUEUING",
              "NEED_TO_RE_SCHEDULE"
            ]
          },
          "zoneList": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Retrieve Zone Firmware Schedule Upgrade Task

GET/v11_1/zoneScheduleUpgrade/{id}

Retrieve Zone Firmware Schedule Upgrade Task

Response  200
HideShow
Body
{
  "taskName": "upgradeTask",
  "scheduleTime": 1620576000000,
  "targetVersion": "6.1.0.0.80",
  "zoneList": [
    {
      "id": "6887d5f2-60af-4b0b-8294-f0d523df8e84",
      "name": "upgradeTask"
    }
  ],
  "status": "PENDING"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "taskName": {
      "description": "Task name",
      "type": "string"
    },
    "scheduleTime": {
      "description": "Schedule time in millisecond timestamp, task will be process in every halt hour (exp: 1:00, 1:30 ...)",
      "type": "integer"
    },
    "targetVersion": {
      "description": "Target version of the firmware upgrade or downgrade process",
      "type": "string"
    },
    "status": {
      "description": "The task process status",
      "type": "string",
      "enum": [
        "PENDING",
        "IN_PROGRESS",
        "EXECUTED",
        "QUEUING",
        "NEED_TO_RE_SCHEDULE"
      ]
    },
    "zoneList": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    }
  }
}

Create Zone Firmware Schedule Upgrade Task

POST/v11_1/zoneScheduleUpgrade

Create Zone Firmware Schedule Upgrade Task

Request
HideShow
Body
{
  "taskName": "upgradeTask",
  "scheduleTime": 1620576000000,
  "targetVersion": "6.1.0.0.80",
  "zoneList": [
    {
      "id": "6887d5f2-60af-4b0b-8294-f0d523df8e84"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "taskName": {
      "description": "Task name",
      "type": "string"
    },
    "scheduleTime": {
      "description": "Schedule time in millisecond timestamp, task will be process in every halt hour (exp: 1:00, 1:30 ...)",
      "type": "integer"
    },
    "targetVersion": {
      "description": "Target version of the firmware upgrade or downgrade process",
      "type": "string"
    },
    "zoneList": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          }
        }
      }
    }
  }
}
Response  201

Modify Zone Firmware Schedule Upgrade Task

PUT/v11_1/zoneScheduleUpgrade/{id}

Modify Zone Firmware Schedule Upgrade Task

Request
HideShow
Body
{
  "taskName": "upgradeTask",
  "scheduleTime": 1620576000000,
  "targetVersion": "6.1.0.0.80",
  "zoneList": [
    {
      "id": "6887d5f2-60af-4b0b-8294-f0d523df8e84"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "taskName": {
      "description": "Task name",
      "type": "string"
    },
    "scheduleTime": {
      "description": "Schedule time in millisecond timestamp, task will be process in every halt hour (exp: 1:00, 1:30 ...)",
      "type": "integer"
    },
    "targetVersion": {
      "description": "Target version of the firmware upgrade or downgrade process",
      "type": "string"
    },
    "zoneList": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          }
        }
      }
    }
  }
}
Response  200

Delete Zone Firmware Schedule Upgrade Task

DELETE/v11_1/zoneScheduleUpgrade/{id}

Delete Zone Firmware Schedule Upgrade Task

Response  200

Bulk Delete Zone Firmware Schedule Upgrade Tasks

DELETE/v11_1/zoneScheduleUpgrade

Bulk Delete Zone Firmware Schedule Upgrade Tasks

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200

Zone AAA

Retrieve - LDAP

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

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

Response  200
HideShow
Body
{
  "id": "32fb8816-60e7-46df-876b-038c655278d4",
  "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
  "name": "rapheal-ldap",
  "description": "",
  "ip": "1.1.1.1",
  "port": 389,
  "baseDomainName": "dc=ldap",
  "adminDomainName": "ibm",
  "password": "admin",
  "keyAttribute": "uid",
  "searchFilter": "objectClass=*",
  "mappings": [
    {
      "id": "afa788e0-6afd-11e4-b9bb-08002716c79f",
      "groupAttr": "*",
      "userRole": {
        "id": "636431d6-c06e-4692-a28f-3914afc2a817",
        "name": "identity user role name",
        "userTrafficProfile": {
          "id": "fbde8510-6972-11e4-926e-08002716c79f",
          "name": "System Default"
        }
      }
    },
    {
      "id": "afaa4800-6afd-11e4-b9bb-08002716c79f",
      "groupAttr": "abcd",
      "userRole": {
        "id": "636431d6-c06e-4692-a28f-3914afc2a817",
        "name": "identity user role name",
        "userTrafficProfile": {
          "id": "fbde8510-6972-11e4-926e-08002716c79f",
          "name": "System Default"
        }
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the LDAP server",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone which the LDAP server belongs to",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "name": {
      "description": "Name of the LDAP server",
      "type": "string"
    },
    "description": {
      "description": "Description of the LDAP server",
      "type": "string"
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer"
    },
    "baseDomainName": {
      "description": "Base domain name",
      "type": "string"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "keyAttribute": {
      "description": "Key attribute",
      "type": "string"
    },
    "searchFilter": {
      "description": "Search filter",
      "type": "string"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "id": {
            "type": "string",
            "description": "Group attribute mapping UUID"
          },
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              },
              "userTrafficProfile": {
                "type": "object",
                "description": "Identity user role",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "User traffic profile UUID"
                  },
                  "name": {
                    "type": "string",
                    "description": "User traffic profile name"
                  }
                }
              },
              "firewallProfileId": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  }
}

Retrieve - HTTP2

GET/v11_1/rkszones/{zoneId}/aaa/http2/{id}

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

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the HTTP2 server",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone which the HTTP2 server belongs to",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "name": {
      "description": "Name of the HTTP2 server",
      "type": "string"
    },
    "description": {
      "description": "Description of the HTTP2 server",
      "type": "string"
    },
    "partnerName": {
      "description": "The partner name of the HTTP2 server",
      "type": "string"
    },
    "token": {
      "description": "The token of the HTTP2 server",
      "type": "string"
    },
    "authenticationApi": {
      "description": "The authentication API of the HTTP2 server",
      "type": "string"
    },
    "accountingApi": {
      "description": "The accounting API of the HTTP2 server",
      "type": "string"
    },
    "coaResponseApi": {
      "description": "The COA response API of the HTTP2 server",
      "type": "string"
    },
    "coaApi": {
      "description": "The COA API of the HTTP2 server",
      "type": "string"
    },
    "sseTimeout": {
      "description": "The SSE timeout of the HTTP2 server",
      "type": "integer"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "id": {
            "type": "string",
            "description": "Group attribute mapping UUID"
          },
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              },
              "userTrafficProfile": {
                "type": "object",
                "description": "Identity user role",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "User traffic profile UUID"
                  },
                  "name": {
                    "type": "string",
                    "description": "User traffic profile name"
                  }
                }
              },
              "firewallProfileId": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  }
}

Retrieve List - ActiveDirectory

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

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

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "a49bf7dd-be4a-45fb-abd6-bc15dcd697c2",
      "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
      "name": "activeDirectoryServerName",
      "description": null,
      "ip": "192.168.1.1",
      "port": 389,
      "windowsDomainName": null,
      "adminDomainName": null,
      "password": "",
      "globalCatalogEnabled": false,
      "mappings": [
        {
          "id": "c7608860-6afd-11e4-b9bb-08002716c79f",
          "groupAttr": "*",
          "userRole": {
            "id": "636431d6-c06e-4692-a28f-3914afc2a817",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "fbde8510-6972-11e4-926e-08002716c79f",
              "name": "System Default"
            }
          }
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the active directory server",
            "type": "string"
          },
          "zoneId": {
            "description": "Identifier of the zone which the active directory server belongs to",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "name": {
            "description": "Name of the active directory server",
            "type": "string"
          },
          "description": {
            "description": "Description of the active directory server",
            "type": "string"
          },
          "ip": {
            "description": "IP address",
            "type": "string"
          },
          "port": {
            "description": "Port",
            "type": "integer"
          },
          "windowsDomainName": {
            "description": "Windows domain name",
            "type": "string"
          },
          "adminDomainName": {
            "description": "Admin domain name",
            "type": "string"
          },
          "password": {
            "description": "Admin password",
            "type": "string"
          },
          "globalCatalogEnabled": {
            "description": "Enable global catalog support",
            "type": "boolean"
          },
          "mappings": {
            "type": "array",
            "description": "Group attribute and user traffic profile mapping",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "User traffic profile mapping",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Group attribute mapping UUID"
                },
                "groupAttr": {
                  "type": "string",
                  "description": "Group attribute"
                },
                "userRole": {
                  "type": "object",
                  "additionalProperties": false,
                  "description": "Identity user role",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Identity user role UUID"
                    },
                    "name": {
                      "description": "Identity user role name",
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 64,
                      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
                    },
                    "userTrafficProfile": {
                      "type": "object",
                      "description": "Identity user role",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "User traffic profile UUID"
                        },
                        "name": {
                          "type": "string",
                          "description": "User traffic profile name"
                        }
                      }
                    },
                    "firewallProfileId": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "groupAttr",
                "userRole"
              ]
            }
          }
        }
      }
    }
  }
}

Retrieve - ActiveDirectory

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

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

Response  200
HideShow
Body
{
  "id": "a49bf7dd-be4a-45fb-abd6-bc15dcd697c2",
  "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
  "name": "activeDirectoryServerName",
  "description": null,
  "ip": "192.168.1.1",
  "port": 389,
  "windowsDomainName": null,
  "adminDomainName": null,
  "password": "",
  "globalCatalogEnabled": false,
  "mappings": [
    {
      "id": "c7608860-6afd-11e4-b9bb-08002716c79f",
      "groupAttr": "*",
      "userRole": {
        "id": "636431d6-c06e-4692-a28f-3914afc2a817",
        "name": "identity user role name",
        "userTrafficProfile": {
          "id": "fbde8510-6972-11e4-926e-08002716c79f",
          "name": "System Default"
        }
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the active directory server",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone which the active directory server belongs to",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "name": {
      "description": "Name of the active directory server",
      "type": "string"
    },
    "description": {
      "description": "Description of the active directory server",
      "type": "string"
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer"
    },
    "windowsDomainName": {
      "description": "Windows domain name",
      "type": "string"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "globalCatalogEnabled": {
      "description": "Enable global catalog support",
      "type": "boolean"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "id": {
            "type": "string",
            "description": "Group attribute mapping UUID"
          },
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              },
              "userTrafficProfile": {
                "type": "object",
                "description": "Identity user role",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "User traffic profile UUID"
                  },
                  "name": {
                    "type": "string",
                    "description": "User traffic profile name"
                  }
                }
              },
              "firewallProfileId": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  }
}

Retrieve List - LDAP

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

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

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "32fb8816-60e7-46df-876b-038c655278d4",
      "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
      "name": "rapheal-ldap",
      "description": "",
      "ip": "1.1.1.1",
      "port": 389,
      "baseDomainName": "dc=ldap",
      "adminDomainName": "ibm",
      "password": "admin",
      "keyAttribute": "uid",
      "searchFilter": "objectClass=*",
      "mappings": [
        {
          "id": "afa788e0-6afd-11e4-b9bb-08002716c79f",
          "groupAttr": "*",
          "userRole": {
            "id": "636431d6-c06e-4692-a28f-3914afc2a817",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "fbde8510-6972-11e4-926e-08002716c79f",
              "name": "System Default"
            }
          }
        },
        {
          "id": "afaa4800-6afd-11e4-b9bb-08002716c79f",
          "groupAttr": "abcd",
          "userRole": {
            "id": "636431d6-c06e-4692-a28f-3914afc2a817",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "fbde8510-6972-11e4-926e-08002716c79f",
              "name": "System Default"
            }
          }
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the LDAP server",
            "type": "string"
          },
          "zoneId": {
            "description": "Identifier of the zone which the LDAP server belongs to",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "name": {
            "description": "Name of the LDAP server",
            "type": "string"
          },
          "description": {
            "description": "Description of the LDAP server",
            "type": "string"
          },
          "ip": {
            "description": "IP address",
            "type": "string"
          },
          "port": {
            "description": "Port",
            "type": "integer"
          },
          "baseDomainName": {
            "description": "Base domain name",
            "type": "string"
          },
          "adminDomainName": {
            "description": "Admin domain name",
            "type": "string"
          },
          "password": {
            "description": "Admin password",
            "type": "string"
          },
          "keyAttribute": {
            "description": "Key attribute",
            "type": "string"
          },
          "searchFilter": {
            "description": "Search filter",
            "type": "string"
          },
          "mappings": {
            "type": "array",
            "description": "Group attribute and user traffic profile mapping",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "User traffic profile mapping",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Group attribute mapping UUID"
                },
                "groupAttr": {
                  "type": "string",
                  "description": "Group attribute"
                },
                "userRole": {
                  "type": "object",
                  "additionalProperties": false,
                  "description": "Identity user role",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Identity user role UUID"
                    },
                    "name": {
                      "description": "Identity user role name",
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 64,
                      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
                    },
                    "userTrafficProfile": {
                      "type": "object",
                      "description": "Identity user role",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "User traffic profile UUID"
                        },
                        "name": {
                          "type": "string",
                          "description": "User traffic profile name"
                        }
                      }
                    },
                    "firewallProfileId": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "groupAttr",
                "userRole"
              ]
            }
          }
        }
      }
    }
  }
}

Retrieve List - HTTP2

GET/v11_1/rkszones/{zoneId}/aaa/http2

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

URI Parameters
HideShow
forAccounting
string (optional) 
Response  200
HideShow
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 HTTP2 server",
            "type": "string"
          },
          "zoneId": {
            "description": "Identifier of the zone which the HTTP2 server belongs to",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "name": {
            "description": "Name of the HTTP2 server",
            "type": "string"
          },
          "description": {
            "description": "Description of the HTTP2 server",
            "type": "string"
          },
          "partnerName": {
            "description": "The partner name of the HTTP2 server",
            "type": "string"
          },
          "token": {
            "description": "The token of the HTTP2 server",
            "type": "string"
          },
          "authenticationApi": {
            "description": "The authentication API of the HTTP2 server",
            "type": "string"
          },
          "accountingApi": {
            "description": "The accounting API of the HTTP2 server",
            "type": "string"
          },
          "coaResponseApi": {
            "description": "The COA response API of the HTTP2 server",
            "type": "string"
          },
          "coaApi": {
            "description": "The COA API of the HTTP2 server",
            "type": "string"
          },
          "sseTimeout": {
            "description": "The SSE timeout of the HTTP2 server",
            "type": "integer"
          },
          "mappings": {
            "type": "array",
            "description": "Group attribute and user traffic profile mapping",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "User traffic profile mapping",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Group attribute mapping UUID"
                },
                "groupAttr": {
                  "type": "string",
                  "description": "Group attribute"
                },
                "userRole": {
                  "type": "object",
                  "additionalProperties": false,
                  "description": "Identity user role",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Identity user role UUID"
                    },
                    "name": {
                      "description": "Identity user role name",
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 64,
                      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
                    },
                    "userTrafficProfile": {
                      "type": "object",
                      "description": "Identity user role",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "User traffic profile UUID"
                        },
                        "name": {
                          "type": "string",
                          "description": "User traffic profile name"
                        }
                      }
                    },
                    "firewallProfileId": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "groupAttr",
                "userRole"
              ]
            }
          }
        }
      }
    }
  }
}

Retrieve - RADIUS

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

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

Response  200
HideShow
Body
{
  "serviceType": "Authentication",
  "id": "RADIUSServerUUID",
  "mvnoId": "userMVNOId",
  "zoneId": "zoneUUID",
  "partnerDomainId": "partnerDomainId",
  "name": "RADIUSServerName",
  "description": "RADIUSServerDescription",
  "primary": {
    "ip": "192.168.1.1",
    "port": 1812,
    "sharedSecret": "sharedSecret"
  },
  "secondary": {
    "ip": "192.168.1.2",
    "port": 1812,
    "sharedSecret": "sharedSecret"
  },
  "mappings": [
    {
      "id": "73587760-6589-11e4-800c-0026b9f85aaf",
      "groupAttr": "abc",
      "userRole": {
        "id": "a4c288b0-63cf-11e4-a18a-080027b147d4",
        "name": "identity user role name",
        "userTrafficProfile": {
          "id": "9474cc20-63cf-11e4-a18a-080027b147d4",
          "name": "rapheal-usertraffic-profile"
        }
      }
    },
    {
      "id": "735e6ad0-6589-11e4-800c-0026b9f85aaf",
      "groupAttr": "*",
      "userRole": {
        "id": "9ac45fd6-a87b-4eef-87d7-b759fed376c5",
        "name": "identity user role name",
        "userTrafficProfile": {
          "id": "03ec5340-60a4-11e4-87fc-080027b147d4",
          "name": "System Default"
        }
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "serviceType": {
      "description": "Identify the RADIUS server is belong to Accounting or Authentication",
      "type": "string",
      "enum": [
        "Authentication",
        "Accounting"
      ]
    },
    "id": {
      "description": "Identifier of the RADIUS server",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone which the RADIUS server belongs to",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "partnerDomainId": {
      "description": "Identifier of the partner domain which the RADIUS server belongs to",
      "type": "string"
    },
    "name": {
      "description": "Name of the RADIUS server",
      "type": "string"
    },
    "description": {
      "description": "Description of the RADIUS server",
      "type": "string"
    },
    "primary": {
      "description": "Primary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secret",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "secondary": {
      "description": "Secondary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secret",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "id": {
            "type": "string",
            "description": "Group attribute mapping UUID"
          },
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              },
              "userTrafficProfile": {
                "type": "object",
                "description": "Identity user role",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "User traffic profile UUID"
                  },
                  "name": {
                    "type": "string",
                    "description": "User traffic profile name"
                  }
                }
              },
              "firewallProfileId": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  }
}

Retrieve List - RADIUS

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

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

URI Parameters
HideShow
forAccounting
string (optional) 

radius server for filtering accounting type(forAccounting=true), not accounting type(forAccounting=false) and both(without forAccounting).

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "serviceType": "Authentication",
      "id": "RADIUSServerUUID",
      "mvnoId": "userMVNOId",
      "zoneId": "zoneUUID",
      "name": "RADIUSServerName",
      "description": "RADIUSServerDescription",
      "primary": {
        "ip": "192.168.1.1",
        "port": 1812,
        "sharedSecret": "sharedSecret"
      },
      "secondary": {
        "ip": "192.168.1.2",
        "port": 1812,
        "sharedSecret": "sharedSecret"
      },
      "mappings": [
        {
          "id": "73587760-6589-11e4-800c-0026b9f85aaf",
          "groupAttr": "abc",
          "userRole": {
            "id": "a4c288b0-63cf-11e4-a18a-080027b147d4",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "9474cc20-63cf-11e4-a18a-080027b147d4",
              "name": "rapheal-usertraffic-profile"
            }
          }
        },
        {
          "id": "735e6ad0-6589-11e4-800c-0026b9f85aaf",
          "groupAttr": "*",
          "userRole": {
            "id": "9ac45fd6-a87b-4eef-87d7-b759fed376c5",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "03ec5340-60a4-11e4-87fc-080027b147d4",
              "name": "System Default"
            }
          }
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "serviceType": {
            "description": "Identify the RADIUS server is belong to Accounting or Authentication",
            "type": "string",
            "enum": [
              "Authentication",
              "Accounting"
            ]
          },
          "id": {
            "description": "Identifier of the RADIUS server",
            "type": "string"
          },
          "zoneId": {
            "description": "Identifier of the zone which the RADIUS server belongs to",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "partnerDomainId": {
            "description": "Identifier of the partner domain which the RADIUS server belongs to",
            "type": "string"
          },
          "name": {
            "description": "Name of the RADIUS server",
            "type": "string"
          },
          "description": {
            "description": "Description of the RADIUS server",
            "type": "string"
          },
          "primary": {
            "description": "Primary RADIUS server",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "description": "Server IP",
                "type": "string"
              },
              "port": {
                "description": "Server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "description": "Server shared secret",
                "type": "string"
              }
            },
            "required": [
              "ip",
              "port",
              "sharedSecret"
            ]
          },
          "secondary": {
            "description": "Secondary RADIUS server",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "description": "Server IP",
                "type": "string"
              },
              "port": {
                "description": "Server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "description": "Server shared secret",
                "type": "string"
              }
            },
            "required": [
              "ip",
              "port",
              "sharedSecret"
            ]
          },
          "mappings": {
            "type": "array",
            "description": "Group attribute and user traffic profile mapping",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "User traffic profile mapping",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Group attribute mapping UUID"
                },
                "groupAttr": {
                  "type": "string",
                  "description": "Group attribute"
                },
                "userRole": {
                  "type": "object",
                  "additionalProperties": false,
                  "description": "Identity user role",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Identity user role UUID"
                    },
                    "name": {
                      "description": "Identity user role name",
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 64,
                      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
                    },
                    "userTrafficProfile": {
                      "type": "object",
                      "description": "Identity user role",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "User traffic profile UUID"
                        },
                        "name": {
                          "type": "string",
                          "description": "User traffic profile name"
                        }
                      }
                    },
                    "firewallProfileId": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "groupAttr",
                "userRole"
              ]
            }
          }
        }
      }
    }
  }
}

Create - LDAP

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

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

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

Create - ActiveDirectory

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

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

Request
HideShow
Body
{
  "name": "activeDirectoryServerName",
  "ip": "192.168.1.1",
  "port": 389,
  "globalCatalogEnabled": false,
  "windowsDomainName": "dc=domain,dc=ruckuswireless,dc=com"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the active directory server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the active directory server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535,
      "default": 389
    },
    "windowsDomainName": {
      "description": "Windows domain name",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "globalCatalogEnabled": {
      "description": "Enable global catalog support",
      "type": "boolean"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  },
  "required": [
    "name",
    "ip",
    "port",
    "globalCatalogEnabled"
  ]
}
Response  201
HideShow
Body
{
  "id": "RADIUSServerUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - HTTP2

POST/v11_1/rkszones/{zoneId}/aaa/http2

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

URI Parameters
HideShow
forAccounting
string (optional) 
Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the HTTP2 server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the HTTP2 server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "partnerName": {
      "description": "The partner name of the HTTP2 server",
      "type": "string"
    },
    "token": {
      "description": "The token of the HTTP2 server",
      "type": "string"
    },
    "authenticationApi": {
      "description": "The authentication API of the HTTP2 server",
      "type": "string"
    },
    "accountingApi": {
      "description": "The accounting API of the HTTP2 server",
      "type": "string"
    },
    "coaResponseApi": {
      "description": "The COA response API of the HTTP2 server",
      "type": "string"
    },
    "coaApi": {
      "description": "The COA API of the HTTP2 server",
      "type": "string"
    },
    "sseTimeout": {
      "description": "The SSE timeout of the HTTP2 server",
      "type": "integer",
      "minimum": 30,
      "maximum": 600,
      "default": 60
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  },
  "required": [
    "name",
    "token"
  ]
}
Response  201
HideShow
Body
{
  "id": "RADIUSServerUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - RADIUS

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

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

URI Parameters
HideShow
forAccounting
string (optional) 

radius server for accounting type. default: false.

Request
HideShow
Body
{
  "name": "RADIUSServerName",
  "primary": {
    "ip": "192.168.1.1",
    "port": 1812,
    "sharedSecret": "sharedSecret"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the RADIUS server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the RADIUS server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "primary": {
      "description": "Primary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secret",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "secondary": {
      "description": "Secondary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secret",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  },
  "required": [
    "name",
    "primary"
  ]
}
Response  201
HideShow
Body
{
  "id": "RADIUSServerUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Entire - LDAP

PUT/v11_1/rkszones/{zoneId}/aaa/ldap/{id}

Use this API command to modify the configuration on LDAP server of a zone by complete attributes.

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

Modify Entire - ActiveDirectory

PUT/v11_1/rkszones/{zoneId}/aaa/ad/{id}

Use this API command to modify the configuration on active directory server of a zone by complete attributes.

Request
HideShow
Body
{
  "name": "new name",
  "ip": "192.168.1.2",
  "port": 3268,
  "globalCatalogEnabled": true,
  "adminDomainName": "[email protected]",
  "password": "admin",
  "mappings": [
    {
      "groupAttr": "newGroupAttr",
      "userRole": {
        "id": "identity user role UUID"
      }
    },
    {
      "groupAttr": "*",
      "userRole": {
        "name": "identity user role name"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the active directory server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the active directory server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "windowsDomainName": {
      "description": "Windows domain name",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "globalCatalogEnabled": {
      "description": "Enable global catalog support",
      "type": "boolean"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  }
}
Response  204

Modify Entire - HTTP2

PUT/v11_1/rkszones/{zoneId}/aaa/http2/{id}

Use this API command to modify the configuration on HTTP2 server of a zone by complete attributes.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the HTTP2 server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the HTTP2 server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "partnerName": {
      "description": "The partner name of the HTTP2 server",
      "type": "string"
    },
    "token": {
      "description": "The token of the HTTP2 server",
      "type": "string"
    },
    "authenticationApi": {
      "description": "The authentication API of the HTTP2 server",
      "type": "string"
    },
    "accountingApi": {
      "description": "The accounting API of the HTTP2 server",
      "type": "string"
    },
    "coaResponseApi": {
      "description": "The COA response API of the HTTP2 server",
      "type": "string"
    },
    "coaApi": {
      "description": "The COA API of the HTTP2 server",
      "type": "string"
    },
    "sseTimeout": {
      "description": "The SSE timeout of the HTTP2 server",
      "type": "integer",
      "minimum": 30,
      "maximum": 600
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  },
  "required": [
    "name",
    "token"
  ]
}
Response  204

Modify Entire - RADIUS

PUT/v11_1/rkszones/{zoneId}/aaa/radius/{id}

Use this API command to modify the configuration on radius server of a zone by complete attributes.

Request
HideShow
Body
{
  "name": "RADIUSServerName",
  "description": "RADIUSServerDescription",
  "primary": {
    "ip": "192.168.1.1",
    "port": 1812,
    "sharedSecret": "abc"
  },
  "secondary": {
    "ip": "192.168.1.2",
    "port": 1812,
    "sharedSecret": "sharedSecret"
  },
  "mappings": [
    {
      "groupAttr": "newGroupAttr",
      "userRole": {
        "id": "identity user role UUID"
      }
    },
    {
      "groupAttr": "*",
      "userRole": {
        "name": "identity user role name"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the RADIUS server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the RADIUS server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "primary": {
      "description": "Primary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secret",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "secondary": {
      "description": "Secondary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secret",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  }
}
Response  204

Modify - LDAP

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

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

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

Modify - ActiveDirectory

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

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

Request
HideShow
Body
{
  "name": "new name",
  "ip": "192.168.1.2",
  "port": 3268,
  "globalCatalogEnabled": true,
  "adminDomainName": "[email protected]",
  "password": "admin",
  "mappings": [
    {
      "groupAttr": "newGroupAttr",
      "userRole": {
        "id": "identity user role UUID"
      }
    },
    {
      "groupAttr": "*",
      "userRole": {
        "name": "identity user role name"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the active directory server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the active directory server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "windowsDomainName": {
      "description": "Windows domain name",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "globalCatalogEnabled": {
      "description": "Enable global catalog support",
      "type": "boolean"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  }
}
Response  204

Modify - RADIUS

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

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

Request
HideShow
Body
{
  "name": "RADIUSServerName",
  "description": "RADIUSServerDescription",
  "primary": {
    "ip": "192.168.1.1",
    "port": 1812,
    "sharedSecret": "abc"
  },
  "secondary": {
    "ip": "192.168.1.2",
    "port": 1812,
    "sharedSecret": "sharedSecret"
  },
  "mappings": [
    {
      "groupAttr": "newGroupAttr",
      "userRole": {
        "id": "identity user role UUID"
      }
    },
    {
      "groupAttr": "*",
      "userRole": {
        "name": "identity user role name"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the RADIUS server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the RADIUS server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "primary": {
      "description": "Primary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secret",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "secondary": {
      "description": "Secondary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secret",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  }
}
Response  204

Delete - LDAP

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

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

Response  204

Delete AAA server

DELETE/v11_1/rkszones/{zoneId}/aaa/{id}

Use this API command to delete an AAA server.

Response  204

Delete - RADIUS

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

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

Response  204

Disable Secondary Server - RADIUS

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

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

Response  204

Delete - ActiveDirectory

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

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

Response  204

Delete a list of AAA server

DELETE/v11_1/rkszones/{zoneId}/aaa

Use this API command to delete a list of AAA server.

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

Delete - HTTP2

DELETE/v11_1/rkszones/{zoneId}/aaa/http2/{id}

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

Response  204

Guest Access

Retrieve

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

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

Response  200
HideShow
Body
{
  "id": "15efd160-7153-11e4-aa08-00606eb0c700",
  "zoneId": "d664f517-cdc5-4997-8248-980a0b7a0542",
  "name": "GuestAccessSmart",
  "description": "basic configuration test",
  "portalCustomization": {
    "language": "en_US",
    "title": "Welcome to the Guest Access login page.",
    "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAmCAYAAAAxxTAbAAAABHNCSVQICAgIfAhkiAAAABB0RVh0U29mdHdhcmUAU2h1dHRlcmOC0AkAAAFESURBVEjH7ZQhSwRBGIafdfebMVywaLQZDf4BMRi1eAh6zWI1+wvMNovNoKbLgqhBDF6wWKwiiCAXVkG92W8MewvHcocMZxCZB7bsvDPv7PvOLEQikUgkEolE/iQXkDnSLSU7U+yLIrki1w6zMUofZJDDtGIeFPGKdJXsXLFXinwp4gvS7WH64C8pyPYd6RqQVO96sFgam8cOSF3/azEqcqOI/8DO1ccmxln4HswnZt5hWkADICWZHXvHp5A67Kpi2or0ypiyZ0VeFfEOu1LXBxl0QArkuFzYXjrMZk5jpsxejuomlT6wdLtTniJ7MFj8KJNKH9RJgl8qJ+sh4H/qt9IHmXj8W1muLgxmXpDtJrA+Sh9Ej8nl/kV0imkXyIlinvpPux5XpQ82cqRNRe4UeVfktsDsdWHKYVrDTpcjbf6fn+o3cnSSVWnHtbYAAAAASUVORK5CYII=",
    "termsAndConditionsText": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
    "termsAndConditionsRequired": true
  },
  "redirect": {
    "url": "http://www.google.com"
  },
  "smsGateway": null,
  "userSession": {
    "timeoutInMin": 180,
    "gracePeriodInMin": 120
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the guest access profile",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone which the guest access profile belongs to",
      "type": "string"
    },
    "name": {
      "description": "Name of the guest access profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the guest access profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "portalCustomization": {
      "description": "Portal customization of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "language": {
          "description": "Language",
          "default": "en_US",
          "type": "string",
          "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": 32000
        }
      },
      "required": [
        "language"
      ]
    },
    "redirect": {
      "description": "Redirect configuration of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "description": "Portal redirect URL",
          "type": "string"
        }
      }
    },
    "smsGateway": {
      "description": "Portal SMS gateway of the guest access profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "userSession": {
      "description": "User session of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "timeoutInMin": {
          "description": "Time out value in minutes",
          "type": "integer",
          "default": 1440,
          "minimum": 2,
          "maximum": 14400
        },
        "gracePeriodInMin": {
          "description": "Grace period in minutes",
          "type": "integer",
          "default": 60,
          "minimum": 1,
          "maximum": 14399
        }
      }
    },
    "selfRegistration": {
      "description": "Enable self registration guest pass.",
      "type": "boolean",
      "default": "false"
    },
    "smtpServerEnabled": {
      "description": "Enable SMTP server setting.",
      "type": "boolean"
    },
    "expirationValue": {
      "description": "Set the expiration time of self registration guest pass.",
      "type": "integer"
    },
    "expirationUnit": {
      "description": "Set the unit of expiration time of self registration guest pass.",
      "type": "string",
      "enum": [
        "HOUR",
        "DAY",
        "WEEK"
      ]
    },
    "passEffectSince": {
      "description": "Set the guest pass effective since creation time or first used.",
      "type": "string",
      "enum": [
        "FROM_CREATION_TIME",
        "FROM_FIRST_USE"
      ]
    },
    "passUseDays": {
      "description": "Set the expiration time for the new self registration guest pass if not used within some days.",
      "type": "integer"
    },
    "maxAllowedDeviceLimitNum": {
      "description": "Set the max. allowed device for one self registration guest pass.",
      "type": "integer"
    },
    "sponsorApproval": {
      "type": "boolean"
    },
    "sponsorAuthServer": {
      "type": "string",
      "enum": [
        "LOCAL_DB",
        "LDAP",
        "AD",
        "RADIUS"
      ]
    },
    "sponsorEmailAddress": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "notificationMethod": {
      "description": "Set the notification method.",
      "type": "string",
      "enum": [
        "MOBILE",
        "EMAIL",
        "MOBILE_AND_EMAIL"
      ]
    },
    "requireLoginAgain": {
      "description": "Required the user login again.",
      "type": "boolean"
    },
    "sessionValue": {
      "description": "Set the value of session.",
      "type": "integer"
    },
    "sessionUnit": {
      "description": "Set the unit of session.",
      "type": "string",
      "enum": [
        "MIN",
        "HOUR",
        "DAY",
        "WEEK"
      ]
    }
  }
}

Retrieve List

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

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

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

Retrieve Guest Access Profile List

POST/v11_1/query/services/guestAccess

Query Guest Access Profiles with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Create

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

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

Request
HideShow
Body
{
  "name": "GuestAccess test",
  "description": "guest access test description",
  "portalCustomization": {
    "language": "en_US",
    "title": "Welcome to the Guest Access login page.",
    "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAmCAYAAAAxxTAbAAAABHNCSVQICAgIfAhkiAAAABB0RVh0U29mdHdhcmUAU2h1dHRlcmOC0AkAAAFESURBVEjH7ZQhSwRBGIafdfebMVywaLQZDf4BMRi1eAh6zWI1+wvMNovNoKbLgqhBDF6wWKwiiCAXVkG92W8MewvHcocMZxCZB7bsvDPv7PvOLEQikUgkEolE/iQXkDnSLSU7U+yLIrki1w6zMUofZJDDtGIeFPGKdJXsXLFXinwp4gvS7WH64C8pyPYd6RqQVO96sFgam8cOSF3/azEqcqOI/8DO1ccmxln4HswnZt5hWkADICWZHXvHp5A67Kpi2or0ypiyZ0VeFfEOu1LXBxl0QArkuFzYXjrMZk5jpsxejuomlT6wdLtTniJ7MFj8KJNKH9RJgl8qJ+sh4H/qt9IHmXj8W1muLgxmXpDtJrA+Sh9Ej8nl/kV0imkXyIlinvpPux5XpQ82cqRNRe4UeVfktsDsdWHKYVrDTpcjbf6fn+o3cnSSVWnHtbYAAAAASUVORK5CYII=",
    "termsAndConditionsRequired": true,
    "termsAndConditionsText": "test"
  },
  "redirect": {
    "url": "http://www.ruckuswireless.com"
  },
  "smsGateway": {
    "name": "defaultServer"
  },
  "userSession": {
    "timeoutInMin": 180,
    "gracePeriodInMin": 120
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the guest access profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the guest access profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "portalCustomization": {
      "description": "Portal customization of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "language": {
          "description": "Language",
          "default": "en_US",
          "type": "string",
          "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": 32000
        }
      },
      "required": [
        "language"
      ]
    },
    "redirect": {
      "description": "Redirect configuration of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "description": "Portal redirect URL",
          "type": "string"
        }
      }
    },
    "smsGateway": {
      "description": "Portal SMS gateway of the guest access profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "userSession": {
      "description": "Redirect configuration of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "timeoutInMin": {
          "description": "Time out value in minutes",
          "type": "integer",
          "default": 1440,
          "minimum": 2,
          "maximum": 14400
        },
        "gracePeriodInMin": {
          "description": "Grace period in minutes",
          "type": "integer",
          "default": 60,
          "minimum": 1,
          "maximum": 14399
        }
      }
    },
    "selfRegistration": {
      "description": "Enable self-registration mechanism",
      "type": "boolean",
      "default": "false"
    },
    "smtpServerEnabled": {
      "description": "Enable SMTP server to send SMS",
      "type": "boolean"
    },
    "expirationValue": {
      "description": "Guest pass expiration value",
      "type": "integer"
    },
    "expirationUnit": {
      "description": "Guest pass expiration unit",
      "type": "string",
      "enum": [
        "HOUR",
        "DAY",
        "WEEK"
      ]
    },
    "passEffectSince": {
      "description": "Assign guest pass effect since creation time or first use",
      "type": "string",
      "enum": [
        "FROM_CREATION_TIME",
        "FROM_FIRST_USE"
      ]
    },
    "passUseDays": {
      "description": "Assign guest pass valid time",
      "type": "integer"
    },
    "maxAllowedDeviceLimitNum": {
      "description": "Assign the max. device count which can use one guest pass",
      "type": "integer"
    },
    "sponsorApproval": {
      "type": "boolean"
    },
    "sponsorAuthServer": {
      "type": "string",
      "enum": [
        "LOCAL_DB",
        "LDAP",
        "AD",
        "RADIUS"
      ]
    },
    "sponsorEmailAddress": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "notificationMethod": {
      "description": "Assign notification method for self-registration guest pass",
      "type": "string",
      "enum": [
        "MOBILE",
        "EMAIL",
        "MOBILE_AND_EMAIL"
      ]
    },
    "requireLoginAgain": {
      "description": "Enable session duration",
      "type": "boolean"
    },
    "sessionValue": {
      "description": "Assign session duration",
      "type": "integer"
    },
    "sessionUnit": {
      "description": "Session unit",
      "type": "string",
      "enum": [
        "MIN",
        "HOUR",
        "DAY",
        "WEEK"
      ]
    }
  },
  "required": [
    "name",
    "portalCustomization",
    "userSession"
  ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

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

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

Request
HideShow
Body
{
  "name": "GuestAccessSmart",
  "description": "basic configuration test",
  "portalCustomization": {
    "language": "zh_TW",
    "title": "Welcome to the Guest Access login page.",
    "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAmCAYAAAAxxTAbAAAABHNCSVQICAgIfAhkiAAAABB0RVh0U29mdHdhcmUAU2h1dHRlcmOC0AkAAAFESURBVEjH7ZQhSwRBGIafdfebMVywaLQZDf4BMRi1eAh6zWI1+wvMNovNoKbLgqhBDF6wWKwiiCAXVkG92W8MewvHcocMZxCZB7bsvDPv7PvOLEQikUgkEolE/iQXkDnSLSU7U+yLIrki1w6zMUofZJDDtGIeFPGKdJXsXLFXinwp4gvS7WH64C8pyPYd6RqQVO96sFgam8cOSF3/azEqcqOI/8DO1ccmxln4HswnZt5hWkADICWZHXvHp5A67Kpi2or0ypiyZ0VeFfEOu1LXBxl0QArkuFzYXjrMZk5jpsxejuomlT6wdLtTniJ7MFj8KJNKH9RJgl8qJ+sh4H/qt9IHmXj8W1muLgxmXpDtJrA+Sh9Ej8nl/kV0imkXyIlinvpPux5XpQ82cqRNRe4UeVfktsDsdWHKYVrDTpcjbf6fn+o3cnSSVWnHtbYAAAAASUVORK5CYII=",
    "termsAndConditionsRequired": true,
    "termsAndConditionsText": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless."
  },
  "redirect": {
    "url": "http://www.google.com"
  },
  "smsGateway": {
    "name": "defaultServer"
  },
  "userSession": {
    "timeoutInMin": 180,
    "gracePeriodInMin": 60
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the guest access profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the guest access profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "portalCustomization": {
      "description": "Portal customization of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "language": {
          "description": "Language",
          "type": "string",
          "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"
        },
        "termsAndConditionsText": {
          "description": "Terms and conditions text",
          "type": "string",
          "minLength": 0,
          "maxLength": 32000
        }
      },
      "required": [
        "language"
      ]
    },
    "redirect": {
      "description": "Redirect configuration of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "description": "Portal redirect URL",
          "type": "string"
        }
      }
    },
    "smsGateway": {
      "description": "Portal SMS gateway of the guest access profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "userSession": {
      "description": "User session of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "timeoutInMin": {
          "description": "Time out value in minutes",
          "type": "integer",
          "minimum": 2,
          "maximum": 14400
        },
        "gracePeriodInMin": {
          "description": "Grace period in minutes",
          "type": "integer",
          "minimum": 1,
          "maximum": 14399
        }
      }
    },
    "selfRegistration": {
      "description": "Enable self registration guest pass.",
      "type": "boolean"
    },
    "smtpServerEnabled": {
      "description": "Enable SMTP server setting.",
      "type": "boolean"
    },
    "expirationValue": {
      "description": "Set the expiration time of self registration guest pass.",
      "type": "integer"
    },
    "expirationUnit": {
      "description": "Set the unit of expiration time of self registration guest pass.",
      "type": "string",
      "enum": [
        "HOUR",
        "DAY",
        "WEEK"
      ]
    },
    "passEffectSince": {
      "description": "Set the guest pass effective since creation time or first used.",
      "type": "string",
      "enum": [
        "FROM_CREATION_TIME",
        "FROM_FIRST_USE"
      ]
    },
    "passUseDays": {
      "description": "Set the expiration time for the new self registration guest pass if not used within some days.",
      "type": "integer"
    },
    "maxAllowedDeviceLimitNum": {
      "description": "Set the max. allowed device for one self registration guest pass.",
      "type": "integer"
    },
    "sponsorApproval": {
      "type": "boolean"
    },
    "sponsorAuthServer": {
      "type": "string",
      "enum": [
        "LOCAL_DB",
        "LDAP",
        "AD",
        "RADIUS"
      ]
    },
    "sponsorEmailAddress": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "notificationMethod": {
      "description": "Set the notification method.",
      "type": "string",
      "enum": [
        "MOBILE",
        "EMAIL",
        "MOBILE_AND_EMAIL"
      ]
    },
    "requireLoginAgain": {
      "description": "Required the user login again.",
      "type": "boolean"
    },
    "sessionValue": {
      "description": "Set the value of session.",
      "type": "integer"
    },
    "sessionUnit": {
      "description": "Set the unit of session.",
      "type": "string",
      "enum": [
        "MIN",
        "HOUR",
        "DAY",
        "WEEK"
      ]
    }
  }
}
Response  204

Delete

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

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

Response  204

Redirect to URL user visit

DELETE/v11_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

Disable SMS Gateway

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

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

Response  204

Hotspot Service

Retrieve

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

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

Response  200
HideShow
Body
‧ Sample : Hotspot with WalledGarden
{
    "name" : "test-hotspot222",
    "id" : "3e5b3782-6f1a-42bf-9812-95d2c1df2451",
    "description" : "description",
    "smartClientSupport" : "None",
    "smartClientInfo" : null,
    "portalType" : "Internal",
    "portalUrl" : null,
    "backupPortalUrl" : null,
    "redirect" : null,
    "portalCustomization" : {
        "language" : "en_US",
        "title" : "Ruckus Wireless - Subscriber Portal",
        "logo" : "logo",
        "termsAndConditionsRequired" : false
    },
    "userSession" : {
        "timeoutInMin" : 1440,
        "gracePeriodInMin" : 60
    },
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "walledGardens" : [ "10.1.1.1", "11.11.111.11" ],
    "zoneId" : "d664f517-cdc5-4997-8248-980a0b7a0542",
    "httpsRedirect" : false,
    "encryptMacIpEnabled" : null
}
‧ Sample : Hotspot with Traffic Class Profile
{
    "name" : "test-hotspot222",
    "id" : "3e5b3782-6f1a-42bf-9812-95d2c1df2451",
    "description" : "description",
    "smartClientSupport" : "None",
    "smartClientInfo" : null,
    "portalType" : "Internal",
    "portalUrl" : null,
    "backupPortalUrl" : null,
    "redirect" : null,
    "portalCustomization" : {
        "language" : "en_US",
        "title" : "Ruckus Wireless - Subscriber Portal",
        "logo" : "logo",
        "termsAndConditionsRequired" : false
    },
    "userSession" : {
        "timeoutInMin" : 1440,
        "gracePeriodInMin" : 60
    },
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "trafficClassProfileId" : "f099db61-a464-11e8-996f-000000031396",
    "signatureSigningKey" : "123456789",
    "internalNode" : "1.1.1.1",
    "zoneId" : "d664f517-cdc5-4997-8248-980a0b7a0542",
    "httpsRedirect" : false,
    "encryptMacIpEnabled" : null
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the Hotspot",
            "type" : "string"
        },
        "zoneId" : {
            "description" : "Identifier of the zone which the Hotspot belongs to",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the Hotspot",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "smartClientSupport" : {
            "description" : "Smart client support of the Hotspot",
            "type" : "string",
            "enum" : [ "None", "Enabled", "SmartClientOnly" ]
        },
        "smartClientInfo" : {
            "description" : "Smart client info of the Hotspot. Type instructions for enabling users to log on using the Smart Client application.",
            "type" : "string"
        },
        "portalType" : {
            "description" : "Portal type of the Hotspot",
            "type" : "string",
            "enum" : [ "Internal", "External" ]
        },
        "portalUrl" : {
            "description" : "Portal URL of the Hotspot",
            "type" : "string"
        },
        "backupPortalUrl" : {
            "type" : [ "string", "null" ]
        },
        "location" : {
            "description" : "Location of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Portal location id",
                    "type" : "string",
                    "minLength" : 1,
                    "maxLength" : 64
                },
                "name" : {
                    "description" : "Portal location name",
                    "type" : "string",
                    "minLength" : 1,
                    "maxLength" : 64
                }
            }
        },
        "redirect" : {
            "description" : "Redirect configuration of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "url" : {
                    "description" : "Portal redirect URL",
                    "type" : "string"
                }
            }
        },
        "portalCustomization" : {
            "description" : "Portal customization of the guest access profile",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "language" : {
                    "description" : "Language",
                    "default" : "en_US",
                    "type" : "string",
                    "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" : 32000
                }
            },
            "required" : [ "language" ]
        },
        "userSession" : {
            "description" : "User session of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "timeoutInMin" : {
                    "description" : "Time out value in minutes",
                    "type" : "integer",
                    "default" : 1440,
                    "minimum" : 2,
                    "maximum" : 14400
                },
                "gracePeriodInMin" : {
                    "description" : "Grace period in minutes",
                    "type" : "integer",
                    "default" : 60,
                    "minimum" : 1,
                    "maximum" : 14399
                }
            }
        },
        "walledGardens" : {
            "description" : "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like    - *.amazon.com    - *.com",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "trafficClassProfileId" : {
            "description" : "Traffic Class Profile of the Hotspot",
            "type" : "string"
        },
        "signatureSigningKey" : {
            "description" : "Signature Signing Key of the Hotspot",
            "type" : "string"
        },
        "internalNode" : {
            "description" : "Internal Node of the Hotspot",
            "type" : "string"
        },
        "macAddressFormat" : {
            "description" : "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
            "type" : "integer",
            "default" : 2,
            "minimum" : 0,
            "maximum" : 5
        },
        "httpsRedirect" : {
            "description" : "HTTPS Redirect is disable or not",
            "type" : "boolean",
            "default" : "true"
        }
    }
}

Retrieve List

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

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

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

Retrieve Hotspot Profile List

POST/v11_1/query/services/hotspot

Query Hotspot Profiles with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Create Internal

POST/v11_1/rkszones/{zoneId}/portals/hotspot/internal

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

Request
HideShow
Body
{
  "name": "test-hotspot222",
  "description": "description",
  "smartClientSupport": "None",
  "location": {
    "id": "locationId",
    "name": "locationName"
  },
  "macAddressFormat": 2,
  "walledGardens": [
    "10.11.12.16",
    "10.11.12.13"
  ],
  "httpsRedirect": true,
  "encryptMacIpEnabled": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Hotspot",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Hotspot",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "smartClientSupport": {
      "description": "Smart client support of the Hotspot",
      "type": "string",
      "enum": [
        "None",
        "Enabled"
      ]
    },
    "location": {
      "description": "Location of the Hotspot",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "Portal location id",
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "name": {
          "description": "Portal location name",
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        }
      }
    },
    "redirect": {
      "description": "Redirect configuration of the Hotspot",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "description": "Portal redirect URL",
          "type": "string"
        }
      }
    },
    "userSession": {
      "description": "User session of the Hotspot",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "timeoutInMin": {
          "description": "Time out value in minutes",
          "type": "integer",
          "default": 1440,
          "minimum": 2,
          "maximum": 14400
        },
        "gracePeriodInMin": {
          "description": "Grace period in minutes",
          "type": "integer",
          "default": 60,
          "minimum": 1,
          "maximum": 14399
        }
      }
    },
    "walledGardens": {
      "description": "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like    - *.amazon.com    - *.com",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "macAddressFormat": {
      "description": "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
      "type": "integer",
      "default": 2,
      "minimum": 0,
      "maximum": 5
    },
    "httpsRedirect": {
      "description": "HTTPS Redirect is disable or not",
      "type": "boolean",
      "default": "true"
    }
  },
  "required": [
    "name",
    "smartClientSupport",
    "macAddressFormat"
  ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create External

POST/v11_1/rkszones/{zoneId}/portals/hotspot/external

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

Request
HideShow
Body
‧ Sample : Create a Hotspot with WalledGarden
{
    "name" : "test-hotspot222",
    "description" : "description",
    "smartClientSupport" : "None",
    "portalUrl" : "https://172.17.26.59",
    "backupPortalUrl" : "https://172.17.26.60",
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "walledGardens" : [ "10.11.12.16", "10.11.12.13" ],
    "httpsRedirect" : true,
    "encryptMacIpEnabled" : null
}
‧ Sample : Create a Hotspot with Traffic Class Profile
{
    "name" : "test-hotspot222",
    "description" : "description",
    "smartClientSupport" : "None",
    "portalUrl" : "https://172.17.26.59",
    "backupPortalUrl" : "https://172.17.26.60",
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "trafficClassProfileId" : "f099db61-a464-11e8-996f-000000031396",
    "signatureSigningKey" : "123456789",
    "internalNode" : "1.1.1.1",
    "httpsRedirect" : true,
    "encryptMacIpEnabled" : null
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the Hotspot",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "smartClientSupport" : {
            "description" : "Smart client support of the Hotspot",
            "type" : "string",
            "enum" : [ "None", "Enabled" ]
        },
        "portalUrl" : {
            "description" : "Portal URL of the Hotspot",
            "type" : "string"
        },
        "backupPortalUrl" : {
            "description" : "Backup Portal URL of the Hotspot",
            "type" : [ "string", "null" ]
        },
        "location" : {
            "description" : "Location of the hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Portal location id",
                    "type" : "string",
                    "minLength" : 1,
                    "maxLength" : 64
                },
                "name" : {
                    "description" : "Portal location name",
                    "type" : "string",
                    "minLength" : 1,
                    "maxLength" : 64
                }
            }
        },
        "redirect" : {
            "description" : "Redirect configuration of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "url" : {
                    "description" : "Portal redirect URL",
                    "type" : "string"
                }
            }
        },
        "userSession" : {
            "description" : "User session of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "timeoutInMin" : {
                    "description" : "Time out value in minutes",
                    "type" : "integer",
                    "default" : 1440,
                    "minimum" : 2,
                    "maximum" : 14400
                },
                "gracePeriodInMin" : {
                    "description" : "Grace period in minutes",
                    "type" : "integer",
                    "default" : 60,
                    "minimum" : 1,
                    "maximum" : 14399
                }
            }
        },
        "walledGardens" : {
            "description" : "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like    - *.amazon.com    - *.com",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "trafficClassProfileId" : {
            "description" : "Traffic Class Profile of the Hotspot",
            "type" : "string"
        },
        "signatureSigningKey" : {
            "description" : "Signature Signing Key of the Hotspot",
            "type" : "string"
        },
        "internalNode" : {
            "description" : "Internal Node of the Hotspot",
            "type" : "string"
        },
        "macAddressFormat" : {
            "description" : "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
            "type" : "integer",
            "default" : 2,
            "minimum" : 0,
            "maximum" : 5
        },
        "httpsRedirect" : {
            "description" : "HTTPS Redirect is disable or not",
            "type" : "boolean",
            "default" : "true"
        }
    },
    "required" : [ "name", "smartClientSupport", "portalUrl", "macAddressFormat" ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create Smart Client Only

POST/v11_1/rkszones/{zoneId}/portals/hotspot/smartClientOnly

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

Request
HideShow
Body
‧ Sample : Create a Hotspot with WalledGarden
{
    "name" : "test-hotspot222-smartClientOnly",
    "description" : "description-smartClientOnly",
    "smartClientInfo" : "smartClient only, yyyy!",
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "walledGardens" : [ "10.11.12.16", "10.11.12.13" ],
    "httpsRedirect" : true,
    "encryptMacIpEnabled" : null
}
‧ Sample : Create a Hotspot with Traffic Class Profile
{
    "name" : "test-hotspot222-smartClientOnly",
    "description" : "description-smartClientOnly",
    "smartClientInfo" : "smartClient only, yyyy!",
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "trafficClassProfileId" : "f099db61-a464-11e8-996f-000000031396",
    "signatureSigningKey" : "123456789",
    "internalNode" : "1.1.1.1",
    "httpsRedirect" : true,
    "encryptMacIpEnabled" : null
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the Hotspot",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "smartClientInfo" : {
            "description" : "Smart client info of the Hotspot. Type instructions for enabling users to log on using the Smart Client application.",
            "type" : "string"
        },
        "location" : {
            "description" : "Location of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Portal location id",
                    "type" : "string",
                    "minLength" : 1,
                    "maxLength" : 64
                },
                "name" : {
                    "description" : "Portal location name",
                    "type" : "string",
                    "minLength" : 1,
                    "maxLength" : 64
                }
            }
        },
        "redirect" : {
            "description" : "Redirect configuration of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "url" : {
                    "description" : "Portal redirect URL",
                    "type" : "string"
                }
            }
        },
        "userSession" : {
            "description" : "Redirect configuration of the Hotspot profile",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "timeoutInMin" : {
                    "description" : "Time out value in minutes",
                    "type" : "integer",
                    "default" : 1440,
                    "minimum" : 2,
                    "maximum" : 14400
                },
                "gracePeriodInMin" : {
                    "description" : "Grace period in minutes",
                    "type" : "integer",
                    "default" : 60,
                    "minimum" : 1,
                    "maximum" : 14399
                }
            }
        },
        "walledGardens" : {
            "description" : "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like    - *.amazon.com    - *.com",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "trafficClassProfileId" : {
            "description" : "Traffic Class Profile of the Hotspot",
            "type" : "string"
        },
        "signatureSigningKey" : {
            "description" : "Signature Signing Key of the Hotspot",
            "type" : "string"
        },
        "internalNode" : {
            "description" : "Internal Node of the Hotspot",
            "type" : "string"
        },
        "macAddressFormat" : {
            "description" : "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
            "type" : "integer",
            "default" : 2,
            "minimum" : 0,
            "maximum" : 5
        },
        "httpsRedirect" : {
            "description" : "HTTPS Redirect is disable or not",
            "type" : "boolean",
            "default" : "true"
        }
    },
    "required" : [ "name", "smartClientInfo", "macAddressFormat" ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Update Internal

PUT/v11_1/rkszones/{zoneId}/portals/hotspot/internal/{id}

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

Request
HideShow
Body
{
  "name": "test-hotspot222",
  "description": "description",
  "smartClientSupport": "None",
  "location": {
    "id": "locationId",
    "name": "locationName"
  },
  "macAddressFormat": 2,
  "walledGardens": [
    "10.11.12.16",
    "10.11.12.13"
  ],
  "httpsRedirect": true,
  "encryptMacIpEnabled": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Hotspot",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Hotspot",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "smartClientSupport": {
      "description": "Smart client support of the Hotspot",
      "type": "string",
      "enum": [
        "None",
        "Enabled"
      ]
    },
    "location": {
      "description": "Location of the Hotspot",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "Portal location id",
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "name": {
          "description": "Portal location name",
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        }
      }
    },
    "redirect": {
      "description": "Redirect configuration of the Hotspot",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "description": "Portal redirect URL",
          "type": "string"
        }
      }
    },
    "userSession": {
      "description": "User session of the Hotspot",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "timeoutInMin": {
          "description": "Time out value in minutes",
          "type": "integer",
          "minimum": 2,
          "maximum": 14400
        },
        "gracePeriodInMin": {
          "description": "Grace period in minutes",
          "type": "integer",
          "minimum": 1,
          "maximum": 14399
        }
      }
    },
    "walledGardens": {
      "description": "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like    - *.amazon.com    - *.com",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "macAddressFormat": {
      "description": "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
      "type": "integer",
      "minimum": 0,
      "maximum": 5
    },
    "httpsRedirect": {
      "description": "HTTPS Redirect is disable or not",
      "type": "boolean"
    }
  },
  "required": [
    "name",
    "smartClientSupport",
    "macAddressFormat"
  ]
}
Response  204

Update External

PUT/v11_1/rkszones/{zoneId}/portals/hotspot/external/{id}

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

Request
HideShow
Body
‧ Sample : Create a Hotspot with WalledGarden
{
    "name" : "test-hotspot222",
    "description" : "description",
    "smartClientSupport" : "None",
    "portalUrl" : "https://172.17.26.59",
    "backupPortalUrl" : "https://172.17.26.60",
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "walledGardens" : [ "10.11.12.16", "10.11.12.13" ],
    "httpsRedirect" : true,
    "encryptMacIpEnabled" : null
}
‧ Sample : Create a Hotspot with Traffic Class Profile
{
    "name" : "test-hotspot222",
    "description" : "description",
    "smartClientSupport" : "None",
    "portalUrl" : "https://172.17.26.59",
    "backupPortalUrl" : "https://172.17.26.60",
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "trafficClassProfileId" : "f099db61-a464-11e8-996f-000000031396",
    "signatureSigningKey" : "123456789",
    "internalNode" : "1.1.1.1",
    "httpsRedirect" : true,
    "encryptMacIpEnabled" : null
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the Hotspot",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "smartClientSupport" : {
            "description" : "Smart client support of the Hotspot",
            "type" : "string",
            "enum" : [ "None", "Enabled" ]
        },
        "portalUrl" : {
            "description" : "Portal URL of the Hotspot",
            "type" : "string"
        },
        "backupPortalUrl" : {
            "description" : "Backup Portal URL of the Hotspot",
            "type" : [ "string", "null" ]
        },
        "location" : {
            "description" : "Location of the hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Portal location id",
                    "type" : "string",
                    "minLength" : 1,
                    "maxLength" : 64
                },
                "name" : {
                    "description" : "Portal location name",
                    "type" : "string",
                    "minLength" : 1,
                    "maxLength" : 64
                }
            }
        },
        "redirect" : {
            "description" : "Redirect configuration of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "url" : {
                    "description" : "Portal redirect URL",
                    "type" : "string"
                }
            }
        },
        "userSession" : {
            "description" : "User session of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "timeoutInMin" : {
                    "description" : "Time out value in minutes",
                    "type" : "integer",
                    "minimum" : 2,
                    "maximum" : 14400
                },
                "gracePeriodInMin" : {
                    "description" : "Grace period in minutes",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 14399
                }
            }
        },
        "walledGardens" : {
            "description" : "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like    - *.amazon.com    - *.com",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "trafficClassProfileId" : {
            "description" : "Traffic Class Profile of the Hotspot",
            "type" : "string"
        },
        "signatureSigningKey" : {
            "description" : "Signature Signing Key of the Hotspot",
            "type" : "string"
        },
        "internalNode" : {
            "description" : "Internal Node of the Hotspot",
            "type" : "string"
        },
        "macAddressFormat" : {
            "description" : "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
            "type" : "integer",
            "minimum" : 0,
            "maximum" : 5
        },
        "httpsRedirect" : {
            "description" : "HTTPS Redirect is disable or not",
            "type" : "boolean"
        }
    },
    "required" : [ "name", "smartClientSupport", "portalUrl", "macAddressFormat" ]
}
Response  204

Update Smart Client Only

PUT/v11_1/rkszones/{zoneId}/portals/hotspot/smartClientOnly/{id}

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

Request
HideShow
Body
‧ Sample : Create a Hotspot with WalledGarden
{
    "name" : "test-hotspot222-smartClientOnly",
    "description" : "description-smartClientOnly",
    "smartClientInfo" : "smartClient only, yyyy!",
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "walledGardens" : [ "10.11.12.16", "10.11.12.13" ],
    "httpsRedirect" : true,
    "encryptMacIpEnabled" : null
}
‧ Sample : Create a Hotspot with Traffic Class Profile
{
    "name" : "test-hotspot222-smartClientOnly",
    "description" : "description-smartClientOnly",
    "smartClientInfo" : "smartClient only, yyyy!",
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "trafficClassProfileId" : "f099db61-a464-11e8-996f-000000031396",
    "signatureSigningKey" : "123456789",
    "internalNode" : "1.1.1.1",
    "httpsRedirect" : true,
    "encryptMacIpEnabled" : null
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the Hotspot",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "smartClientInfo" : {
            "description" : "Smart client info of the Hotspot. Type instructions for enabling users to log on using the Smart Client application.",
            "type" : "string"
        },
        "location" : {
            "description" : "Location of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Portal location id",
                    "type" : "string",
                    "minLength" : 1,
                    "maxLength" : 64
                },
                "name" : {
                    "description" : "Portal location name",
                    "type" : "string",
                    "minLength" : 1,
                    "maxLength" : 64
                }
            }
        },
        "redirect" : {
            "description" : "Redirect configuration of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "url" : {
                    "description" : "Portal redirect URL",
                    "type" : "string"
                }
            }
        },
        "userSession" : {
            "description" : "Redirect configuration of the Hotspot profile",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "timeoutInMin" : {
                    "description" : "Time out value in minutes",
                    "type" : "integer",
                    "minimum" : 2,
                    "maximum" : 14400
                },
                "gracePeriodInMin" : {
                    "description" : "Grace period in minutes",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 14399
                }
            }
        },
        "walledGardens" : {
            "description" : "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like    - *.amazon.com    - *.com",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "trafficClassProfileId" : {
            "description" : "Traffic Class Profile of the Hotspot",
            "type" : "string"
        },
        "signatureSigningKey" : {
            "description" : "Signature Signing Key of the Hotspot",
            "type" : "string"
        },
        "internalNode" : {
            "description" : "Internal Node of the Hotspot",
            "type" : "string"
        },
        "macAddressFormat" : {
            "description" : "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
            "type" : "integer",
            "minimum" : 0,
            "maximum" : 5
        },
        "httpsRedirect" : {
            "description" : "HTTPS Redirect is disable or not",
            "type" : "boolean"
        }
    },
    "required" : [ "name", "smartClientInfo", "macAddressFormat" ]
}
Response  204

Modify

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

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

Request
HideShow
Body
‧ Sample : Modify a Hotspot with WalledGarden
{
    "name" : "test-hotspot-modify",
    "description" : "description-modify",
    "smartClientSupport" : "Enabled",
    "portalUrl" : "https://172.17.26.59",
    "backupPortalUrl" : "https://172.17.26.60",
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "redirect" : {
        "url" : "https://www.testurl.com"
    },
    "portalCustomization" : {
        "language" : "en_US",
        "title" : "Ruckus Wireless - Subscriber Portal",
        "logo" : "logo",
        "termsAndConditionsRequired" : false
    },
    "userSession" : {
        "timeoutInMin" : 1440,
        "gracePeriodInMin" : 60
    },
    "macAddressFormat" : 2,
    "walledGardens" : [ "10.1.1.1", "11.11.111.11" ],
    "httpsRedirect" : true,
    "encryptMacIpEnabled" : null
}
‧ Sample : Modify a Hotspot with Traffic Class Profile
{
    "name" : "test-hotspot-modify",
    "description" : "description-modify",
    "smartClientSupport" : "Enabled",
    "portalUrl" : "https://172.17.26.59",
    "backupPortalUrl" : "https://172.17.26.60",
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "redirect" : {
        "url" : "https://www.testurl.com"
    },
    "portalCustomization" : {
        "language" : "en_US",
        "title" : "Ruckus Wireless - Subscriber Portal",
        "logo" : "logo",
        "termsAndConditionsRequired" : false
    },
    "userSession" : {
        "timeoutInMin" : 1440,
        "gracePeriodInMin" : 60
    },
    "macAddressFormat" : 2,
    "trafficClassProfileId" : "f099db61-a464-11e8-996f-000000031396",
    "signatureSigningKey" : "123456789",
    "internalNode" : "1.1.1.1",
    "httpsRedirect" : true,
    "encryptMacIpEnabled" : null
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the Hotspot",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "smartClientSupport" : {
            "description" : "Smart client support of the Hotspot",
            "type" : "string",
            "enum" : [ "None", "Enabled" ]
        },
        "smartClientInfo" : {
            "description" : "Smart client info of the Hotspot. Type instructions for enabling users to log on using the Smart Client application.",
            "type" : "string"
        },
        "portalUrl" : {
            "description" : "Portal URL of the Hotspot",
            "type" : "string"
        },
        "backupPortalUrl" : {
            "type" : [ "string", "null" ]
        },
        "location" : {
            "description" : "Location of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Portal location id",
                    "type" : "string",
                    "minLength" : 1,
                    "maxLength" : 64
                },
                "name" : {
                    "description" : "Portal location name",
                    "type" : "string",
                    "minLength" : 1,
                    "maxLength" : 64
                }
            }
        },
        "redirect" : {
            "description" : "Redirect configuration of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "url" : {
                    "description" : "Portal redirect URL",
                    "type" : "string"
                }
            }
        },
        "portalCustomization" : {
            "description" : "Portal customization of the guest access profile",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "language" : {
                    "description" : "Language",
                    "type" : "string",
                    "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"
                },
                "termsAndConditionsText" : {
                    "description" : "Terms and conditions text",
                    "type" : "string",
                    "minLength" : 0,
                    "maxLength" : 32000
                }
            },
            "required" : [ "language" ]
        },
        "userSession" : {
            "description" : "User session of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "timeoutInMin" : {
                    "description" : "Time out value in minutes",
                    "type" : "integer",
                    "minimum" : 2,
                    "maximum" : 14400
                },
                "gracePeriodInMin" : {
                    "description" : "Grace period in minutes",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 14399
                }
            }
        },
        "walledGardens" : {
            "description" : "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like    - *.amazon.com    - *.com",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "trafficClassProfileId" : {
            "description" : "Traffic Class Profile of the Hotspot",
            "type" : "string"
        },
        "signatureSigningKey" : {
            "description" : "Signature Signing Key of the Hotspot",
            "type" : "string"
        },
        "internalNode" : {
            "description" : "Internal Node of the Hotspot",
            "type" : "string"
        },
        "macAddressFormat" : {
            "description" : "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
            "type" : "integer",
            "minimum" : 0,
            "maximum" : 5
        },
        "httpsRedirect" : {
            "description" : "HTTPS Redirect is disable or not",
            "type" : "boolean"
        }
    }
}
Response  204

Delete

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

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

Response  204

Hotspot20 WLAN Service

Retrieve List

GET/v11_1/rkszones/{zoneId}/hs20s

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

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

Retrieve

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

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

Response  200
HideShow
Body
{
  "id": "b6af6e80-8409-11e4-a4e7-80fa5b024259",
  "name": "test-hs20Wlan",
  "description": "test-hs20Wlan-desc",
  "operator": {
    "id": "e6373c40-8194-11e4-aa2e-000c299b4765",
    "name": "operatorTEST"
  },
  "identityProviders": [
    {
      "id": "9eec1055-45dd-45c5-a631-f1b76530bb67",
      "name": "identityProviderDisabled"
    },
    {
      "id": "5fc11810-c8bd-4876-9acf-356a1f4727a3",
      "name": "identityProviderEnabled"
    }
  ],
  "defaultIdentityProvider": {
    "id": "5fc11810-c8bd-4876-9acf-356a1f4727a3",
    "name": "identityProviderEnabled"
  },
  "signupSsid": {
    "id": "1",
    "name": "osenWlan"
  },
  "internetOption": true,
  "accessNetworkType": "FREE_PUBLIC",
  "ipv4AddressType": "UNAVAILABLE",
  "ipv6AddressType": "UNAVAILABLE",
  "connectionCapabilities": [
    {
      "protocolName": "ICMP",
      "protocolNumber": 1,
      "portNumber": 0,
      "status": "OPEN"
    },
    {
      "protocolName": "FTP",
      "protocolNumber": 6,
      "portNumber": 20,
      "status": "OPEN"
    },
    {
      "protocolName": "SSH",
      "protocolNumber": 6,
      "portNumber": 22,
      "status": "CLOSED"
    },
    {
      "protocolName": "HTTP",
      "protocolNumber": 6,
      "portNumber": 80,
      "status": "CLOSED"
    },
    {
      "protocolName": "Used by TLS VPN",
      "protocolNumber": 6,
      "portNumber": 443,
      "status": "CLOSED"
    },
    {
      "protocolName": "Used by PPTP VPNs",
      "protocolNumber": 6,
      "portNumber": 1723,
      "status": "CLOSED"
    },
    {
      "protocolName": "VoIP",
      "protocolNumber": 6,
      "portNumber": 5060,
      "status": "CLOSED"
    },
    {
      "protocolName": "VoIP",
      "protocolNumber": 17,
      "portNumber": 5060,
      "status": "CLOSED"
    },
    {
      "protocolName": "Used by IKEv2(IPSec VPN)",
      "protocolNumber": 17,
      "portNumber": 500,
      "status": "CLOSED"
    },
    {
      "protocolName": "IPSec VPN",
      "protocolNumber": 17,
      "portNumber": 4500,
      "status": "CLOSED"
    },
    {
      "protocolName": "ESP",
      "protocolNumber": 50,
      "portNumber": 0,
      "status": "CLOSED"
    }
  ],
  "customConnectionCapabilities": [
    {
      "protocolName": "ICMP",
      "protocolNumber": 2,
      "portNumber": 0,
      "status": "OPEN"
    },
    {
      "protocolName": "FTP",
      "protocolNumber": 2,
      "portNumber": 20,
      "status": "OPEN"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the Hotspot 2.0 WLAN profile",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone which the Hotspot 2.0 WLAN profile belongs to",
      "type": "string"
    },
    "name": {
      "description": "Name of the Hotspot 2.0 WLAN profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Hotspot 2.0 WLAN profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "operator": {
      "description": "Operator of the Hotspot 2.0 WLAN profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "identityProviders": {
      "description": "Identity providers of the Hotspot 2.0 WLAN profile",
      "type": "array",
      "items": {
        "type": [
          "object",
          "null"
        ],
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    },
    "defaultIdentityProvider": {
      "description": "Default identity provider of the Hotspot 2.0 WLAN profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "signupSsid": {
      "description": "Signup SSID of the Hotspot 2.0 WLAN profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "internetOption": {
      "description": "Internet option of the Hotspot 2.0 WLAN profile",
      "type": "boolean"
    },
    "accessNetworkType": {
      "description": "Access network type of the Hotspot 2.0 WLAN profile",
      "type": "string",
      "enum": [
        "CHARGEABLE_PUBLIC",
        "FREE_PUBLIC",
        "PERSONAL_DEVICE",
        "PRIVATE",
        "PRIVATE_WITH_GUEST",
        "TEST",
        "WILDCARD"
      ]
    },
    "ipv4AddressType": {
      "description": "IPv4 address type of the v WLAN profile",
      "type": "string",
      "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",
      "type": "string",
      "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",
            "type": "string",
            "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",
            "type": "string",
            "enum": [
              "CLOSED",
              "OPEN",
              "UNKNOWN"
            ]
          }
        },
        "required": [
          "protocolName",
          "protocolNumber",
          "portNumber",
          "status"
        ]
      }
    },
    "singleSsidEnabled": {
      "description": "Single SSID of the Hotspot 2.0 WLAN profile. When Online Signup is enabled and Single SSID is disabled, Onboarding SSID will be required.",
      "type": "boolean",
      "default": false
    }
  }
}

Retrieve Hotspot20 Profile List

POST/v11_1/query/services/hotspot20Profile

Query Hotspot20 Profiles with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Create

POST/v11_1/rkszones/{zoneId}/hs20s

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

Request
HideShow
Body
{
  "name": "hotspot20WlanCreate",
  "description": "hotspot20 Wlan profile Create desc",
  "operator": {
    "id": "e6373c40-8194-11e4-aa2e-000c299b4765",
    "name": "operatorTEST"
  },
  "identityProviders": [
    {
      "id": "9eec1055-45dd-45c5-a631-f1b76530bb67",
      "name": "identityProviderDisabled"
    },
    {
      "id": "5fc11810-c8bd-4876-9acf-356a1f4727a3",
      "name": "identityProviderEnabled"
    }
  ],
  "defaultIdentityProvider": {
    "id": "5fc11810-c8bd-4876-9acf-356a1f4727a3",
    "name": "identityProviderEnabled"
  },
  "signupSsid": {
    "id": "1",
    "name": "osenWlan"
  },
  "internetOption": true,
  "accessNetworkType": "CHARGEABLE_PUBLIC",
  "ipv4AddressType": "UNAVAILABLE",
  "ipv6AddressType": "UNAVAILABLE"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Hotspot 2.0 WLAN profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Hotspot 2.0 WLAN profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "operator": {
      "description": "Operator of the Hotspot 2.0 WLAN profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "identityProviders": {
      "description": "Ddentity providers of the Hotspot 2.0 WLAN profile",
      "type": "array",
      "items": {
        "type": [
          "object",
          "null"
        ],
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    },
    "defaultIdentityProvider": {
      "description": "Default identity provider of the Hotspot 2.0 WLAN profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "signupSsid": {
      "description": "Signup SSID of the Hotspot 2.0 WLAN profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "internetOption": {
      "description": "Internet option of the Hotspot 2.0 WLAN profile",
      "type": "boolean"
    },
    "accessNetworkType": {
      "description": "Access network type of the Hotspot 2.0 WLAN profile",
      "type": "string",
      "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",
      "type": "string",
      "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",
      "type": "string",
      "enum": [
        "UNAVAILABLE",
        "AVAILABLE",
        "UNKNOWN"
      ]
    },
    "singleSsidEnabled": {
      "description": "Single SSID of the Hotspot 2.0 WLAN profile. When Online Signup is enabled and Single SSID is disabled, Onboarding SSID will be required.",
      "type": "boolean",
      "default": false
    }
  },
  "required": [
    "name",
    "operator",
    "defaultIdentityProvider",
    "internetOption",
    "accessNetworkType",
    "ipv4AddressType",
    "ipv6AddressType"
  ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

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

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

Request
HideShow
Body
{
  "name": "hotspot20WlanProfilePath",
  "description": "hotspot20 wlan profile pathc desc",
  "operator": {
    "id": "e6373c40-8194-11e4-aa2e-000c299b4765",
    "name": "operatorTEST"
  },
  "identityProviders": [
    {
      "id": "9eec1055-45dd-45c5-a631-f1b76530bb67",
      "name": "identityProviderDisabled"
    },
    {
      "id": "5fc11810-c8bd-4876-9acf-356a1f4727a3",
      "name": "identityProviderEnabled"
    }
  ],
  "defaultIdentityProvider": {
    "id": "5fc11810-c8bd-4876-9acf-356a1f4727a3",
    "name": "identityProviderEnabled"
  },
  "signupSsid": {
    "id": "1",
    "name": "osenWlan"
  },
  "internetOption": true,
  "accessNetworkType": "CHARGEABLE_PUBLIC",
  "ipv4AddressType": "UNAVAILABLE",
  "ipv6AddressType": "UNAVAILABLE",
  "connectionCapabilities": [
    {
      "protocolName": "ICMP",
      "protocolNumber": 1,
      "portNumber": 0,
      "status": "OPEN"
    },
    {
      "protocolName": "FTP",
      "protocolNumber": 6,
      "portNumber": 20,
      "status": "OPEN"
    },
    {
      "protocolName": "SSH",
      "protocolNumber": 6,
      "portNumber": 22,
      "status": "UNKNOWN"
    },
    {
      "protocolName": "HTTP",
      "protocolNumber": 6,
      "portNumber": 80,
      "status": "CLOSED"
    },
    {
      "protocolName": "Used by TLS VPN",
      "protocolNumber": 6,
      "portNumber": 443,
      "status": "CLOSED"
    },
    {
      "protocolName": "Used by PPTP VPNs",
      "protocolNumber": 6,
      "portNumber": 1723,
      "status": "CLOSED"
    },
    {
      "protocolName": "VoIP",
      "protocolNumber": 6,
      "portNumber": 5060,
      "status": "CLOSED"
    },
    {
      "protocolName": "VoIP",
      "protocolNumber": 17,
      "portNumber": 5060,
      "status": "CLOSED"
    },
    {
      "protocolName": "Used by IKEv2(IPSec VPN)",
      "protocolNumber": 17,
      "portNumber": 500,
      "status": "CLOSED"
    },
    {
      "protocolName": "IPSec VPN",
      "protocolNumber": 17,
      "portNumber": 4500,
      "status": "CLOSED"
    },
    {
      "protocolName": "ESP",
      "protocolNumber": 50,
      "portNumber": 0,
      "status": "CLOSED"
    }
  ],
  "customConnectionCapabilities": [
    {
      "protocolName": "ICMP",
      "protocolNumber": 2,
      "portNumber": 0,
      "status": "OPEN"
    },
    {
      "protocolName": "FTP",
      "protocolNumber": 2,
      "portNumber": 20,
      "status": "OPEN"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Hotspot 2.0 WLAN profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Hotspot 2.0 WLAN profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "operator": {
      "description": "Operator of the Hotspot 2.0 WLAN profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "identityProviders": {
      "description": "Identity providers of the Hotspot 2.0 WLAN profile",
      "type": "array",
      "items": {
        "type": [
          "object",
          "null"
        ],
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    },
    "defaultIdentityProvider": {
      "description": "Default identity provider of the Hotspot 2.0 WLAN profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "signupSsid": {
      "description": "Signup SSID of the Hotspot 2.0 WLAN profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "internetOption": {
      "description": "Internet option of the Hotspot 2.0 WLAN profile",
      "type": "boolean"
    },
    "accessNetworkType": {
      "description": "Access network type of the Hotspot 2.0 WLAN profile",
      "type": "string",
      "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",
      "type": "string",
      "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",
      "type": "string",
      "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",
            "type": "string",
            "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",
            "type": "string",
            "enum": [
              "CLOSED",
              "OPEN",
              "UNKNOWN"
            ]
          }
        },
        "required": [
          "protocolName",
          "protocolNumber",
          "portNumber",
          "status"
        ]
      }
    },
    "singleSsidEnabled": {
      "description": "Single SSID of the Hotspot 2.0 WLAN profile. When Online Signup is enabled and Single SSID is disabled, Onboarding SSID will be required. ",
      "type": "boolean"
    }
  }
}
Response  204

Delete

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

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

Response  204

Hotspot20 Venue Service

Retrieve List

GET/v11_1/rkszones/{zoneId}/hs20/venues

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

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

Retrieve

GET/v11_1/rkszones/{zoneId}/hs20/venues/{id}

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

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

Retrieve Venue Profile List

POST/v11_1/query/services/venueProfile

Query Venue Profiles with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Create

POST/v11_1/rkszones/{zoneId}/hs20/venues

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

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

Modify

PATCH/v11_1/rkszones/{zoneId}/hs20/venues/{id}

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

Request
HideShow
Body
{
  "name": "test-hs20Venue-modify",
  "description": "des-hs20Venue-modify",
  "group": "UtilityAndMiscellaneous",
  "type": "Unspecified",
  "downlinkSpeedInKbps": 111111,
  "uplinkSpeedInKbps": 11111,
  "venueNames": [
    {
      "language": "English",
      "name": "add friendly name"
    },
    {
      "language": "German",
      "name": "add friendly name"
    },
    {
      "language": "Japanese",
      "name": "add friendly name"
    },
    {
      "language": "Swedish",
      "name": "add friendly name"
    },
    {
      "language": "Turkish",
      "name": "add friendly name"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Hotspot 2.0 venue profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Hotspot 2.0 venue profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "group": {
      "description": "Category group of the Hotspot 2.0 venue profile",
      "type": "string",
      "enum": [
        "Unspecified",
        "Assembly",
        "Business",
        "Educational",
        "FactoryAndIndustrial",
        "Institutional",
        "Mercantile",
        "Residential",
        "Storage",
        "UtilityAndMiscellaneous",
        "Vehicular",
        "Outdoor"
      ]
    },
    "type": {
      "description": "Category type of the Hotspot 2.0 venue profile",
      "type": "string"
    },
    "downlinkSpeedInKbps": {
      "description": "Link Speed of the Hotspot 2.0 venue profile",
      "type": "number",
      "minimum": 0,
      "maximum": 4294967295
    },
    "uplinkSpeedInKbps": {
      "description": "Link Speed of the Hotspot 2.0 venue profile",
      "type": "number",
      "minimum": 0,
      "maximum": 4294967295
    },
    "venueNames": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "language": {
            "description": "Friendly name of venue",
            "type": "string",
            "enum": [
              "English",
              "Chinese",
              "Czech",
              "Danish",
              "Dutch",
              "French",
              "German",
              "Japanese",
              "Spanish",
              "Korean",
              "Swedish",
              "Turkish",
              "eng",
              "chi",
              "cze",
              "dan",
              "dut",
              "fre",
              "ger",
              "jpn",
              "kor",
              "spa",
              "swe",
              "tur"
            ]
          },
          "name": {
            "description": "Venue name",
            "type": "string"
          },
          "venueUrls": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "language",
          "name"
        ]
      }
    }
  }
}
Response  204

Delete

DELETE/v11_1/rkszones/{zoneId}/hs20/venues/{id}

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

Response  204

Web Authentication

Retrieve

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

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

Response  200
HideShow
Body
{
  "name": "Web Authentication Modify",
  "id": "3e769bc0-7ead-11e4-9517-00606eb0c700",
  "description": "Web Authentication Modify Description",
  "portalLanguage": "en_US",
  "redirect": {
    "url": "https://www.ruckuswireless.com"
  },
  "userSession": {
    "timeoutInMin": 180,
    "gracePeriodInMin": 120
  },
  "webAuthenticationPortalCustomization": {
    "title": "Welcome to the Web Authentication login page.",
    "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAmCAYAAAAxxTAbAAAABHNCSVQICAgIfAhkiAAAABB0RVh0U29mdHdhcmUAU2h1dHRlcmOC0AkAAAFESURBVEjH7ZQhSwRBGIafdfebMVywaLQZDf4BMRi1eAh6zWI1+wvMNovNoKbLgqhBDF6wWKwiiCAXVkG92W8MewvHcocMZxCZB7bsvDPv7PvOLEQikUgkEolE/iQXkDnSLSU7U+yLIrki1w6zMUofZJDDtGIeFPGKdJXsXLFXinwp4gvS7WH64C8pyPYd6RqQVO96sFgam8cOSF3/azEqcqOI/8DO1ccmxln4HswnZt5hWkADICWZHXvHp5A67Kpi2or0ypiyZ0VeFfEOu1LXBxl0QArkuFzYXjrMZk5jpsxejuomlT6wdLtTniJ7MFj8KJNKH9RJgl8qJ+sh4H/qt9IHmXj8W1muLgxmXpDtJrA+Sh9Ej8nl/kV0imkXyIlinvpPux5XpQ82cqRNRe4UeVfktsDsdWHKYVrDTpcjbf6fn+o3cnSSVWnHtbYAAAAASUVORK5CYII="
  },
  "zoneId": "b4187899-38ae-4ace-8e40-0bc444455156"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the web authentication profile",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone which the web authentication profile belongs to",
      "type": "string"
    },
    "name": {
      "description": "Name of the web authentication profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the web authentication profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "portalLanguage": {
      "description": "Language",
      "default": "en_US",
      "type": "string",
      "enum": [
        "en_US",
        "zh_TW",
        "zh_CN",
        "nl_NL",
        "fr_FR",
        "de_DE",
        "ja_JP",
        "es_ES",
        "se_SE",
        "ar_SA",
        "cz_CZ",
        "da_DK",
        "tr_TR",
        "pt_BR"
      ]
    },
    "redirect": {
      "description": "Redirect configuration of the web authentication profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "description": "Portal redirect URL",
          "type": "string"
        }
      }
    },
    "userSession": {
      "description": "User session of the web authentication profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "timeoutInMin": {
          "description": "Time out value in minutes",
          "type": "integer",
          "default": 1440,
          "minimum": 2,
          "maximum": 14400
        },
        "gracePeriodInMin": {
          "description": "Grace period in minutes",
          "type": "integer",
          "default": 60,
          "minimum": 1,
          "maximum": 14399
        }
      }
    },
    "webAuthenticationPortalCustomization": {
      "description": "Portal customization of the web authentication profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "title": {
          "description": "Title of the custom portal",
          "type": "string",
          "minLength": 0,
          "maxLength": 63
        },
        "logo": {
          "description": "Logo encoded with base64, format is \"data:image/png;base64,the base64 encoded logo\"",
          "type": "string"
        }
      },
      "required": [
        "logo"
      ]
    }
  }
}

Retrieve List

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

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

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

Retrieve Web Authentication profile List

POST/v11_1/query/services/webAuthentication

Query Web Authentications with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Create

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

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

Request
HideShow
Body
{
  "name": "Web Authentication Create",
  "description": "Web Authentication Create Description",
  "redirect": {
    "url": "https://www.ruckuswireless.com"
  },
  "webAuthenticationPortalCustomization": {
    "title": "Welcome to the Web Authentication login page.",
    "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAmCAYAAAAxxTAbAAAABHNCSVQICAgIfAhkiAAAABB0RVh0U29mdHdhcmUAU2h1dHRlcmOC0AkAAAFESURBVEjH7ZQhSwRBGIafdfebMVywaLQZDf4BMRi1eAh6zWI1+wvMNovNoKbLgqhBDF6wWKwiiCAXVkG92W8MewvHcocMZxCZB7bsvDPv7PvOLEQikUgkEolE/iQXkDnSLSU7U+yLIrki1w6zMUofZJDDtGIeFPGKdJXsXLFXinwp4gvS7WH64C8pyPYd6RqQVO96sFgam8cOSF3/azEqcqOI/8DO1ccmxln4HswnZt5hWkADICWZHXvHp5A67Kpi2or0ypiyZ0VeFfEOu1LXBxl0QArkuFzYXjrMZk5jpsxejuomlT6wdLtTniJ7MFj8KJNKH9RJgl8qJ+sh4H/qt9IHmXj8W1muLgxmXpDtJrA+Sh9Ej8nl/kV0imkXyIlinvpPux5XpQ82cqRNRe4UeVfktsDsdWHKYVrDTpcjbf6fn+o3cnSSVWnHtbYAAAAASUVORK5CYII="
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the web authentication profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the web authentication profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "redirect": {
      "description": "Redirect configuration of the web authentication profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "description": "Portal redirect URL",
          "type": "string"
        }
      }
    },
    "webAuthenticationPortalCustomization": {
      "description": "Portal customization of the web authentication profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "title": {
          "description": "Title of the custom portal",
          "type": "string",
          "minLength": 0,
          "maxLength": 63
        },
        "logo": {
          "description": "Logo encoded with base64, format is \"data:image/png;base64,the base64 encoded logo\"",
          "type": "string"
        }
      },
      "required": [
        "logo"
      ]
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

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

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

Request
HideShow
Body
{
  "name": "Web Authentication Modify",
  "description": "Web Authentication Modify Description",
  "portalLanguage": "en_US",
  "redirect": {
    "url": "https://www.ruckuswireless.com"
  },
  "userSession": {
    "timeoutInMin": 180,
    "gracePeriodInMin": 120
  },
  "webAuthenticationPortalCustomization": {
    "title": "Welcome to the Web Authentication login page.",
    "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAmCAYAAAAxxTAbAAAABHNCSVQICAgIfAhkiAAAABB0RVh0U29mdHdhcmUAU2h1dHRlcmOC0AkAAAFESURBVEjH7ZQhSwRBGIafdfebMVywaLQZDf4BMRi1eAh6zWI1+wvMNovNoKbLgqhBDF6wWKwiiCAXVkG92W8MewvHcocMZxCZB7bsvDPv7PvOLEQikUgkEolE/iQXkDnSLSU7U+yLIrki1w6zMUofZJDDtGIeFPGKdJXsXLFXinwp4gvS7WH64C8pyPYd6RqQVO96sFgam8cOSF3/azEqcqOI/8DO1ccmxln4HswnZt5hWkADICWZHXvHp5A67Kpi2or0ypiyZ0VeFfEOu1LXBxl0QArkuFzYXjrMZk5jpsxejuomlT6wdLtTniJ7MFj8KJNKH9RJgl8qJ+sh4H/qt9IHmXj8W1muLgxmXpDtJrA+Sh9Ej8nl/kV0imkXyIlinvpPux5XpQ82cqRNRe4UeVfktsDsdWHKYVrDTpcjbf6fn+o3cnSSVWnHtbYAAAAASUVORK5CYII="
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the web authentication profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the web authentication profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "portalLanguage": {
      "description": "Language",
      "type": "string",
      "enum": [
        "en_US",
        "zh_TW",
        "zh_CN",
        "nl_NL",
        "fr_FR",
        "de_DE",
        "ja_JP",
        "es_ES",
        "se_SE",
        "ar_SA",
        "cz_CZ",
        "da_DK",
        "tr_TR",
        "pt_BR"
      ]
    },
    "redirect": {
      "description": "Redirect configuration of the web authentication profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "description": "Portal redirect URL",
          "type": "string"
        }
      }
    },
    "userSession": {
      "description": "User session of the web authentication profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "timeoutInMin": {
          "description": "Time out value in minutes",
          "type": "integer",
          "minimum": 2,
          "maximum": 14400
        },
        "gracePeriodInMin": {
          "description": "Grace period in minutes",
          "type": "integer",
          "minimum": 1,
          "maximum": 14399
        }
      }
    },
    "webAuthenticationPortalCustomization": {
      "description": "Portal customization of the web authentication profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "title": {
          "description": "Title of the custom portal",
          "type": "string",
          "minLength": 0,
          "maxLength": 63
        },
        "logo": {
          "description": "Logo encoded with base64, format is \"data:image/png;base64,the base64 encoded logo\"",
          "type": "string"
        }
      },
      "required": [
        "logo"
      ]
    }
  }
}
Response  204

Delete

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

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

Response  204

Redirect to URL user visit

DELETE/v11_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

Wechat

Retrieve

GET/v11_1/rkszones/{zoneId}/portals/wechat/{id}

Use this API command to retrieve wechat portal by ID.

Response  200
HideShow
Body
{
  "name": "wechat_name",
  "description": "wechat_desc",
  "authUrl": "http://www.ruckuswireless.com",
  "dnatDestination": "ruckus",
  "gracePeriod": 60,
  "blackList": "172.15.20.80",
  "whiteList": [
    "10.1.2.3",
    "10.9.0.5"
  ],
  "dnatPortMapping": [
    {
      "sourcePort": 80,
      "destPort": 80
    },
    {
      "sourcePort": 60,
      "destPort": 60
    },
    {
      "sourcePort": 83,
      "destPort": 85
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the wechat profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the wechat profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "authUrl": {
      "description": "Authentication URL of the wechat profile",
      "type": "string"
    },
    "dnatDestination": {
      "description": "DNAT destination of the wechat profile",
      "type": "string"
    },
    "gracePeriod": {
      "description": "Grace period of the wechat profile",
      "type": "integer",
      "default": 60,
      "minimum": 1,
      "maximum": 14399
    },
    "blackList": {
      "description": "Black list of the wechat profile",
      "type": "string"
    },
    "whiteList": {
      "description": "White list of the wechat profile",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "dnatPortMapping": {
      "description": "DNAT Port Mapping of the wechat profile",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "sourcePort": {
            "description": "Source port",
            "type": "integer",
            "minimum": 0,
            "maximum": 65535
          },
          "destPort": {
            "description": "Destination port",
            "type": "integer",
            "minimum": 0,
            "maximum": 65535
          }
        }
      }
    }
  }
}

Retrieve List

GET/v11_1/rkszones/{zoneId}/portals/wechat

Use this API command to retrieve a list of wechat portal.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

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

Retrieve wechat portal List

POST/v11_1/query/services/wechatProfile

Query Wechat Portals with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Create

POST/v11_1/rkszones/{zoneId}/portals/wechat

Use this API command to create wechat portal.

Request
HideShow
Body
{
  "name": "wechat_create_name",
  "description": "wechat_create_desc",
  "authUrl": "http://www.ruckuswireless.com",
  "dnatDestination": "ruckus",
  "gracePeriod": 60,
  "blackList": "172.15.20.80",
  "whiteList": [
    "10.1.2.3",
    "10.9.0.5"
  ],
  "dnatPortMapping": [
    {
      "sourcePort": 80,
      "destPort": 80
    },
    {
      "sourcePort": 60,
      "destPort": 60
    },
    {
      "sourcePort": 83,
      "destPort": 85
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the wechat profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the wechat profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "authUrl": {
      "description": "Authentication URL of the wechat profile",
      "type": "string"
    },
    "dnatDestination": {
      "description": "DNAT destination of the wechat profile",
      "type": "string"
    },
    "gracePeriod": {
      "description": "Grace period of the wechat profile",
      "type": "integer",
      "default": 60,
      "minimum": 1,
      "maximum": 14399
    },
    "blackList": {
      "description": "Black list of the wechat profile",
      "type": "string"
    },
    "whiteList": {
      "description": "White list of the wechat profile",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "dnatPortMapping": {
      "description": "DNAT Port Mapping of the wechat profile",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "sourcePort": {
            "description": "Source port",
            "type": "integer",
            "minimum": 0,
            "maximum": 65535
          },
          "destPort": {
            "description": "Destination port",
            "type": "integer",
            "minimum": 0,
            "maximum": 65535
          }
        }
      }
    }
  },
  "required": [
    "name",
    "authUrl",
    "dnatDestination",
    "blackList",
    "whiteList"
  ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v11_1/rkszones/{zoneId}/portals/wechat/{id}

Use this API command to modify the configuration of wechat portal.

Request
HideShow
Body
{
  "name": "wechat_modify_name",
  "description": "wechat_modify_desc",
  "authUrl": "http://www.ruckuswireless.com",
  "dnatDestination": "ruckus",
  "gracePeriod": 60,
  "blackList": "172.15.20.80",
  "whiteList": [
    "10.1.2.3",
    "10.9.0.5"
  ],
  "dnatPortMapping": [
    {
      "sourcePort": 80,
      "destPort": 80
    },
    {
      "sourcePort": 60,
      "destPort": 60
    },
    {
      "sourcePort": 83,
      "destPort": 85
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the wechat profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the wechat profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "authUrl": {
      "description": "Authentication URL of the wechat profile",
      "type": "string"
    },
    "dnatDestination": {
      "description": "DNAT destination of the wechat profile",
      "type": "string"
    },
    "gracePeriod": {
      "description": "Grace period of the wechat profile",
      "type": "integer",
      "minimum": 1,
      "maximum": 14399
    },
    "blackList": {
      "description": "Black list of the wechat profile",
      "type": "string"
    },
    "whiteList": {
      "description": "White list of the wechat profile",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "dnatPortMapping": {
      "description": "DNAT Port Mapping of the wechat profile",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "sourcePort": {
            "description": "Source port",
            "type": "integer",
            "minimum": 0,
            "maximum": 65535
          },
          "destPort": {
            "description": "Destination port",
            "type": "integer",
            "minimum": 0,
            "maximum": 65535
          }
        }
      }
    }
  }
}
Response  204

Delete

DELETE/v11_1/rkszones/{zoneId}/portals/wechat/{id}

Use this API command to delete wechat portal.

Response  204

Firewall Profile

Retrieve

GET/v11_1/firewallProfiles

Retrieve Firewall Profile list.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

domainId
string (optional) 

The domain ID. Default: current logon domain ID

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": [
          "object",
          "null"
        ],
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve

GET/v11_1/firewallProfiles/{id}

Retrieve a Firewall Profile.

Response  200
HideShow
Body
{
  "id": "839f87c6-d116-497e-afce-aa8157abdasd",
  "name": "Firewall profile1",
  "description": "f description",
  "uplinkRateLimitingMbps": 200,
  "downlinkRateLimitingMbps": 150,
  "factoryDefault": false,
  "l3AccessControlPolicyId": "839f87c6-d116-497e-afce-aa8157ab1111",
  "l2AccessControlPolicyId": "839f87c6-d116-497e-afce-aa8157ab1111",
  "appPolicyId": "839f87c6-d116-497e-afce-aa8157ab1111",
  "urlFilteringPolicyId": "839f87c6-d116-497e-afce-aa8157ab1111",
  "devicePolicyId": "839f87c6-d116-497e-afce-aa8157ab1111"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Firewall Profile id",
      "type": "string"
    },
    "name": {
      "description": "Name of the Firewall Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Firewall Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "uplinkRateLimitingMbps": {
      "description": "Uplink rate limiting, range 0.1 ~ 200 mpbs",
      "type": "number"
    },
    "downlinkRateLimitingMbps": {
      "description": "Downlink rate limiting, range 0.1 ~ 200 mpbs",
      "type": "number"
    },
    "factoryDefault": {
      "description": "Whether the proFirewall Profile is factory default or not",
      "type": "boolean"
    },
    "l3AccessControlPolicyId": {
      "description": "L3 Access Control Policy",
      "type": "string"
    },
    "l2AccessControlPolicyId": {
      "description": "L2 Access Control Policy",
      "type": "string"
    },
    "appPolicyId": {
      "description": "Application Policy",
      "type": "string"
    },
    "urlFilteringPolicyId": {
      "description": "Url Filtering Policy",
      "type": "string"
    },
    "devicePolicyId": {
      "description": "Device Policy",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id of The Firewall Profile",
      "type": "string"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer",
      "format": "int64"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer",
      "format": "int64"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    }
  }
}

Retrieve WLANs

GET/v11_1/firewallProfiles/{id}/wlans

Retrieve a WLAN list of Firewall Profile is used by

Response  200
HideShow
Body
{
  "totalCount": 5,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "name": "None",
      "status": null,
      "alerts": null,
      "ssid": "None",
      "authMethod": "OPEN",
      "encryptionMethod": "NONE",
      "clients": null,
      "traffic": null,
      "vlan": 1,
      "applicationVisibility": "Disabled",
      "clientVirtualIdExtractionEnabled": "Disabled",
      "tunneled": "APBridged",
      "zeroITOnboard": "Disabled",
      "zeroITEnabled": "Disabled",
      "trafficUplink": null,
      "trafficDownlink": null,
      "enability11r": null,
      "enability11k": null,
      "description": "",
      "wlanId": "5",
      "wpaVersion": "",
      "wepEncryptionStrength": 0,
      "availability": 1,
      "tenantId": "",
      "tenantDomainName": "",
      "firewallProfileId": null
    },
    {
      "name": "WEP128",
      "status": null,
      "alerts": null,
      "ssid": "WEP128",
      "authMethod": "OPEN",
      "encryptionMethod": "WEP",
      "clients": null,
      "traffic": null,
      "vlan": 1,
      "applicationVisibility": "Disabled",
      "clientVirtualIdExtractionEnabled": "Disabled",
      "tunneled": "APBridged",
      "zeroITOnboard": "Disabled",
      "zeroITEnabled": "Disabled",
      "trafficUplink": null,
      "trafficDownlink": null,
      "enability11r": null,
      "enability11k": null,
      "description": "",
      "wlanId": "4",
      "wpaVersion": "WEP128",
      "wepEncryptionStrength": 26,
      "tenantId": "",
      "tenantDomainName": "",
      "firewallProfileId": null
    },
    {
      "name": "WEP64",
      "status": null,
      "alerts": null,
      "ssid": "WEP64",
      "authMethod": "OPEN",
      "encryptionMethod": "WEP",
      "clients": null,
      "traffic": null,
      "vlan": 1,
      "applicationVisibility": "Disabled",
      "clientVirtualIdExtractionEnabled": "Disabled",
      "tunneled": "APBridged",
      "zeroITOnboard": "Disabled",
      "zeroITEnabled": "Disabled",
      "trafficUplink": null,
      "trafficDownlink": null,
      "enability11r": null,
      "enability11k": null,
      "description": "",
      "wlanId": "3",
      "wpaVersion": "WEP64",
      "wepEncryptionStrength": 10,
      "tenantId": "",
      "tenantDomainName": "",
      "firewallProfileId": "607f0c32-c219-11e8-aa07-000000539553"
    },
    {
      "name": "WPA-Mixed",
      "status": null,
      "alerts": null,
      "ssid": "WPA-Mixed",
      "authMethod": "OPEN",
      "encryptionMethod": "WPA",
      "clients": null,
      "traffic": null,
      "vlan": 1,
      "applicationVisibility": "Disabled",
      "clientVirtualIdExtractionEnabled": "Disabled",
      "tunneled": "APBridged",
      "zeroITOnboard": "Disabled",
      "zeroITEnabled": "Disabled",
      "trafficUplink": null,
      "trafficDownlink": null,
      "enability11r": null,
      "enability11k": null,
      "description": "",
      "wlanId": "2",
      "wpaVersion": "AUTO",
      "wepEncryptionStrength": 0,
      "tenantId": "",
      "tenantDomainName": "",
      "firewallProfileId": "607f0c32-c219-11e8-aa07-000000539553"
    },
    {
      "name": "wpa2",
      "status": null,
      "alerts": null,
      "ssid": "wpa2",
      "authMethod": "OPEN",
      "encryptionMethod": "WPA",
      "clients": null,
      "traffic": null,
      "vlan": 1,
      "applicationVisibility": "Disabled",
      "clientVirtualIdExtractionEnabled": "Disabled",
      "tunneled": "APBridged",
      "zeroITOnboard": "Disabled",
      "zeroITEnabled": "Disabled",
      "trafficUplink": null,
      "trafficDownlink": null,
      "enability11r": null,
      "enability11k": null,
      "description": "",
      "wlanId": "1",
      "wpaVersion": "WPA2",
      "wepEncryptionStrength": 0,
      "tenantId": "",
      "tenantDomainName": "",
      "firewallProfileId": "607f0c32-c219-11e8-aa07-000000539553"
    }
  ],
  "extra": {
    "rbacMetadata": [
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      },
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      },
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      },
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      },
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      }
    ]
  }
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "totalCount": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for wlan list",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "clients": {
            "type": "integer"
          },
          "applicationVisibility": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "clientVirtualIdExtractionEnabled": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "zeroITOnboard": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "trafficUplink": {
            "type": "integer"
          },
          "description": {
            "type": "string"
          },
          "zeroITEnabled": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "ssid": {
            "type": "string"
          },
          "wlanId": {
            "type": "string"
          },
          "encryptionMethod": {
            "type": "string"
          },
          "enability11k": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "alerts": {
            "type": "integer"
          },
          "tunneled": {
            "type": "string",
            "enum": [
              "Tunneled",
              "APBridged"
            ]
          },
          "vlan": {
            "type": "integer"
          },
          "enability11r": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "name": {
            "type": "string"
          },
          "authMethod": {
            "type": "string"
          },
          "authType": {
            "type": "string"
          },
          "domainName": {
            "type": "string"
          },
          "zoneName": {
            "type": "string"
          },
          "zoneId": {
            "type": "string"
          },
          "trafficDownlink": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "Online",
              "Flagged",
              "Offline"
            ]
          },
          "traffic": {
            "type": "integer"
          },
          "wpaVersion": {
            "type": "string"
          },
          "wepEncryptionStrength": {
            "type": "integer"
          },
          "availability": {
            "type": "integer"
          },
          "tenantId": {
            "type": "string"
          },
          "tenantDomainName": {
            "type": "string"
          },
          "utp": {
            "type": "string"
          },
          "firewallProfileId": {
            "type": "string"
          },
          "firewallProfile": {
            "type": "string"
          },
          "oweTransWlanId": {
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve

GET/v11_1/firewallProfiles/{id}/ethernetPortProfiles

Retrieve a EthernetPort Profile list of Firewall Profile is used by

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "0",
      "name": "Default Trunk Port"
    },
    {
      "id": "1",
      "name": "Default Access Port"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the service",
            "type": "string"
          },
          "name": {
            "description": "Name of the service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          }
        }
      }
    }
  }
}

Retrieve List

POST/v11_1/firewallProfiles/query

Retrieve a list of Firewall Profile. Please click the link for the usage of Query Criteria.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        },
        "includeSystemDefault": {
          "description": "Include the system default Firewall profile as well while querying.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "list": [
    {
      "id": "839f87c6-d116-497e-afce-aa8157abdasd",
      "name": "Firewall profile1",
      "description": "f1 description",
      "uplinkRateLimitingMbps": 200,
      "downlinkRateLimitingMbps": 150,
      "factoryDefault": false,
      "l3AccessControlPolicyId": "",
      "l2AccessControlPolicyId": "",
      "appPolicyId": "",
      "urlFilteringPolicyId": "",
      "devicePolicyId": ""
    },
    {
      "id": "839f87c6-d116-497e-afce-aa8157ab1111",
      "name": "Firewall profile2",
      "description": "f2 description",
      "uplinkRateLimitingMbps": 200,
      "downlinkRateLimitingMbps": 150,
      "factoryDefault": false,
      "l3AccessControlPolicyId": "839f87c6-d116-497e-afce-aa8157ab1111",
      "l2AccessControlPolicyId": "839f87c6-d116-497e-afce-aa8157ab1111",
      "appPolicyId": "839f87c6-d116-497e-afce-aa8157ab1111",
      "urlFilteringPolicyId": "839f87c6-d116-497e-afce-aa8157ab1111",
      "devicePolicyId": "839f87c6-d116-497e-afce-aa8157ab1111"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Firewall Profile id",
            "type": "string"
          },
          "name": {
            "description": "Name of the Firewall Profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the Firewall Profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "uplinkRateLimitingMbps": {
            "description": "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type": "number"
          },
          "downlinkRateLimitingMbps": {
            "description": "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type": "number"
          },
          "factoryDefault": {
            "description": "Whether the proFirewall Profile is factory default or not",
            "type": "boolean"
          },
          "l3AccessControlPolicyId": {
            "description": "L3 Access Control Policy",
            "type": "string"
          },
          "l2AccessControlPolicyId": {
            "description": "L2 Access Control Policy",
            "type": "string"
          },
          "appPolicyId": {
            "description": "Application Policy",
            "type": "string"
          },
          "urlFilteringPolicyId": {
            "description": "Url Filtering Policy",
            "type": "string"
          },
          "devicePolicyId": {
            "description": "Device Policy",
            "type": "string"
          },
          "domainId": {
            "description": "Domain Id of The Firewall Profile",
            "type": "string"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer",
            "format": "int64"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer",
            "format": "int64"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Create

POST/v11_1/firewallProfiles

Create a Firewall Profile.

Request
HideShow
Body
‧ Sample : Create a firewall profile with all profile having reference.
{
    "domainId" : "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
    "name" : "Firewall profile1",
    "description" : "f description",
    "uplinkRateLimitingMbps" : 200,
    "downlinkRateLimitingMbps" : 150,
    "l3AccessControlPolicyId" : "839f87c6-d116-497e-afce-aa8157ab1111",
    "l2AccessControlPolicyId" : "839f87c6-d116-497e-afce-aa8157ab1111",
    "appPolicyId" : "839f87c6-d116-497e-afce-aa8157ab1111",
    "urlFilteringPolicyId" : "839f87c6-d116-497e-afce-aa8157ab1111",
    "devicePolicyId" : "839f87c6-d116-497e-afce-aa8157ab1111"
}
‧ Sample : Create a firewall profile with some profiles disabled
{
    "domainId" : "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
    "name" : "Firewall profile2",
    "description" : "f description",
    "uplinkRateLimitingMbps" : 200,
    "downlinkRateLimitingMbps" : 150,
    "l3AccessControlPolicyId" : "839f87c6-d116-497e-afce-aa8157ab1111",
    "l2AccessControlPolicyId" : "",
    "appPolicyId" : "",
    "urlFilteringPolicyId" : "839f87c6-d116-497e-afce-aa8157ab1111",
    "devicePolicyId" : "839f87c6-d116-497e-afce-aa8157ab1111"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the Firewall Profile",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Firewall Profile",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "uplinkRateLimitingMbps" : {
            "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "downlinkRateLimitingMbps" : {
            "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
            "type" : "number"
        },
        "l3AccessControlPolicyId" : {
            "description" : "L3 Access Control Policy",
            "type" : "string"
        },
        "l2AccessControlPolicyId" : {
            "description" : "L2 Access Control Policy",
            "type" : "string"
        },
        "appPolicyId" : {
            "description" : "Application Policy",
            "type" : "string"
        },
        "urlFilteringPolicyId" : {
            "description" : "Url Filtering Policy",
            "type" : "string"
        },
        "devicePolicyId" : {
            "description" : "Device Policy",
            "type" : "string"
        },
        "domainId" : {
            "description" : "Domain Id of The Firewall Profile",
            "type" : "string"
        }
    },
    "required" : [ "name" ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PUT/v11_1/firewallProfiles/{id}

Modify a Firewall Profile.

Request
HideShow
Body
{
  "name": "Firewall profile1",
  "description": "f description",
  "uplinkRateLimitingMbps": 200,
  "downlinkRateLimitingMbps": 150,
  "l3AccessControlPolicyId": "839f87c6-d116-497e-afce-aa8157ab1111",
  "l2AccessControlPolicyId": "839f87c6-d116-497e-afce-aa8157ab1111",
  "appPolicyId": "839f87c6-d116-497e-afce-aa8157ab1111",
  "urlFilteringPolicyId": "839f87c6-d116-497e-afce-aa8157ab1111",
  "devicePolicyId": "839f87c6-d116-497e-afce-aa8157ab1111"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Firewall Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Firewall Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "uplinkRateLimitingMbps": {
      "description": "Uplink rate limiting, range 0.1 ~ 200 mpbs",
      "type": "number"
    },
    "downlinkRateLimitingMbps": {
      "description": "Downlink rate limiting, range 0.1 ~ 200 mpbs",
      "type": "number"
    },
    "l3AccessControlPolicyId": {
      "description": "L3 Access Control Policy",
      "type": "string"
    },
    "l2AccessControlPolicyId": {
      "description": "L2 Access Control Policy",
      "type": "string"
    },
    "appPolicyId": {
      "description": "Application Policy",
      "type": "string"
    },
    "urlFilteringPolicyId": {
      "description": "Url Filtering Policy",
      "type": "string"
    },
    "devicePolicyId": {
      "description": "Device Policy",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id of The Firewall Profile",
      "type": "string"
    }
  }
}
Response  204

Delete

DELETE/v11_1/firewallProfiles/{id}

Delete a Firewall Profile.

Response  204

Bulk Delete

DELETE/v11_1/firewallProfiles

Use this API command to delete Bulk Firewall Profiles.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

L3 Access Control Policy

Retrieve

GET/v11_1/l3AccessControlPolicies

Retrieve L3 Access Control Policy list.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

domainId
string (optional) 

The domain ID. Default: current logon domain ID

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": [
          "object",
          "null"
        ],
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve

GET/v11_1/l3AccessControlPolicies/{id}

Retrieve a L3 Access Control Policy.

Response  200
HideShow
Body
{
  "name": "L3 Access Control policy",
  "description": "l3 description",
  "l3AclRuleList": [
    {
      "priority": 1,
      "description": "Allow DNS",
      "ipType": "IPv6",
      "enableSourceV6Prefix": true,
      "sourceIpV6": "",
      "action": "ALLOW",
      "direction": "INBOUND"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "ID of the L3 Access Control Policy",
      "type": "string"
    },
    "name": {
      "description": "Name of the L3 Access Control Policy",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the L3 Access Control Policy",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "defaultAction": {
      "description": "Default action",
      "default": "ALLOW",
      "type": "string",
      "enum": [
        "BLOCK",
        "ALLOW"
      ]
    },
    "l3AclRuleList": {
      "type": "array",
      "description": "L3 access control list",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "type": "integer",
            "description": "Priority"
          },
          "description": {
            "description": "Description of the traffic access control rule",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "ipType": {
            "description": "IP Type(IPv4 or IPv6).",
            "default": "IPv4",
            "type": "string",
            "enum": [
              "IPv4",
              "IPv6"
            ]
          },
          "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"
          },
          "enableSourceV6Prefix": {
            "description": "Enable Source IPv6 prefix.",
            "type": "boolean"
          },
          "sourceIpV6": {
            "type": "string",
            "description": "Source IPv6 Address."
          },
          "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"
          },
          "enableDestinationV6Prefix": {
            "description": "Enable Destination IPv6 prefix.",
            "type": "boolean"
          },
          "destinationIpV6": {
            "type": "string",
            "description": "Destination IPv6 Address."
          },
          "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.",
            "type": "string",
            "enum": [
              "TCP",
              "UDP",
              "UDPLITE",
              "ICMP_ICMPV4",
              "ICMPV6",
              "IGMP",
              "ESP",
              "AH",
              "SCTP",
              "CUSTOM"
            ]
          },
          "customProtocol": {
            "type": "integer",
            "minimum": 1,
            "maximum": 255,
            "description": "The protocol of traffic access control. Available if the protocol is set to CUSTOM."
          },
          "action": {
            "description": "The access of traffic access control.",
            "default": "ALLOW",
            "type": "string",
            "enum": [
              "ALLOW",
              "BLOCK"
            ]
          },
          "direction": {
            "description": "The direction of traffic access control.",
            "default": "INBOUND",
            "type": "string",
            "enum": [
              "INBOUND",
              "OUTBOUND",
              "DUAL"
            ]
          }
        }
      }
    },
    "domainId": {
      "description": "Domain UUID",
      "type": "string"
    }
  },
  "required": [
    "name",
    "defaultAction"
  ]
}

Retrieve List

POST/v11_1/l3AccessControlPolicies/query

Retrieve a list of L3 Access Control Policy. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "list": [
    {
      "name": "L3 Access Control policy",
      "description": "l3 description",
      "l3AclRuleList": [
        {
          "priority": 1,
          "description": "Allow DNS",
          "ipType": "IPv6",
          "enableSourceV6Prefix": true,
          "sourceIpV6": "",
          "action": "ALLOW",
          "direction": "INBOUND"
        }
      ]
    },
    {
      "name": "L3 Access Control policy",
      "description": "l3 description",
      "l3AclRuleList": [
        {
          "description": "acl rule description",
          "enableSourceIpSubnet": true,
          "sourceIp": "172.17.26.55",
          "sourceIpMask": "255.255.255.0",
          "enableSourcePortRange": false,
          "sourceMinPort": 89,
          "enableDestinationPortRange": false,
          "destinationIp": "172.17.26.60",
          "destinationIpMask": "255.255.0.0",
          "protocol": "TCP",
          "action": "ALLOW",
          "direction": "DUAL"
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "ID of the L3 Access Control Policy",
            "type": "string"
          },
          "name": {
            "description": "Name of the L3 Access Control Policy",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the L3 Access Control Policy",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "defaultAction": {
            "description": "Default action",
            "default": "ALLOW",
            "type": "string",
            "enum": [
              "BLOCK",
              "ALLOW"
            ]
          },
          "l3AclRuleList": {
            "type": "array",
            "description": "L3 access control list",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "priority": {
                  "type": "integer",
                  "description": "Priority"
                },
                "description": {
                  "description": "Description of the traffic access control rule",
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 64
                },
                "ipType": {
                  "description": "IP Type(IPv4 or IPv6).",
                  "default": "IPv4",
                  "type": "string",
                  "enum": [
                    "IPv4",
                    "IPv6"
                  ]
                },
                "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"
                },
                "enableSourceV6Prefix": {
                  "description": "Enable Source IPv6 prefix.",
                  "type": "boolean"
                },
                "sourceIpV6": {
                  "type": "string",
                  "description": "Source IPv6 Address."
                },
                "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"
                },
                "enableDestinationV6Prefix": {
                  "description": "Enable Destination IPv6 prefix.",
                  "type": "boolean"
                },
                "destinationIpV6": {
                  "type": "string",
                  "description": "Destination IPv6 Address."
                },
                "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.",
                  "type": "string",
                  "enum": [
                    "TCP",
                    "UDP",
                    "UDPLITE",
                    "ICMP_ICMPV4",
                    "ICMPV6",
                    "IGMP",
                    "ESP",
                    "AH",
                    "SCTP",
                    "CUSTOM"
                  ]
                },
                "customProtocol": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 255,
                  "description": "The protocol of traffic access control. Available if the protocol is set to CUSTOM."
                },
                "action": {
                  "description": "The access of traffic access control.",
                  "default": "ALLOW",
                  "type": "string",
                  "enum": [
                    "ALLOW",
                    "BLOCK"
                  ]
                },
                "direction": {
                  "description": "The direction of traffic access control.",
                  "default": "INBOUND",
                  "type": "string",
                  "enum": [
                    "INBOUND",
                    "OUTBOUND",
                    "DUAL"
                  ]
                }
              }
            }
          },
          "domainId": {
            "description": "Domain UUID",
            "type": "string"
          }
        },
        "required": [
          "name",
          "defaultAction"
        ]
      }
    }
  }
}

Create

POST/v11_1/l3AccessControlPolicies

Create a L3 Access Control Policy.

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "L3 Access Control policy",
  "description": "l3 description",
  "l3AclRuleList": [
    {
      "description": "acl rule description",
      "enableSourceIpSubnet": true,
      "sourceIp": "172.17.26.55",
      "sourceIpMask": "255.255.255.0",
      "enableSourcePortRange": false,
      "sourceMinPort": 89,
      "enableDestinationPortRange": false,
      "destinationIp": "172.17.26.60",
      "destinationIpMask": "255.255.0.0",
      "protocol": "TCP",
      "action": "ALLOW",
      "direction": "DUAL"
    },
    {
      "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": "INBOUND"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the L3 Access Control Policy",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the L3 Access Control Policy",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "defaultAction": {
      "description": "Default action",
      "default": "ALLOW",
      "type": "string",
      "enum": [
        "BLOCK",
        "ALLOW"
      ]
    },
    "l3AclRuleList": {
      "type": "array",
      "description": "L3 access control list",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "type": "integer",
            "description": "Priority"
          },
          "description": {
            "description": "Description of the traffic access control rule",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "ipType": {
            "description": "IP Type(IPv4 or IPv6).",
            "default": "IPv4",
            "type": "string",
            "enum": [
              "IPv4",
              "IPv6"
            ]
          },
          "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"
          },
          "enableSourceV6Prefix": {
            "description": "Enable Source IPv6 prefix.",
            "type": "boolean"
          },
          "sourceIpV6": {
            "type": "string",
            "description": "Source IPv6 Address."
          },
          "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"
          },
          "enableDestinationV6Prefix": {
            "description": "Enable Destination IPv6 prefix.",
            "type": "boolean"
          },
          "destinationIpV6": {
            "type": "string",
            "description": "Destination IPv6 Address."
          },
          "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.",
            "type": "string",
            "enum": [
              "TCP",
              "UDP",
              "UDPLITE",
              "ICMP_ICMPV4",
              "ICMPV6",
              "IGMP",
              "ESP",
              "AH",
              "SCTP",
              "CUSTOM"
            ]
          },
          "customProtocol": {
            "type": "integer",
            "minimum": 1,
            "maximum": 255,
            "description": "The protocol of traffic access control. Available if the protocol is set to CUSTOM."
          },
          "action": {
            "description": "The access of traffic access control.",
            "default": "ALLOW",
            "type": "string",
            "enum": [
              "ALLOW",
              "BLOCK"
            ]
          },
          "direction": {
            "description": "The direction of traffic access control.",
            "default": "INBOUND",
            "type": "string",
            "enum": [
              "INBOUND",
              "OUTBOUND",
              "DUAL"
            ]
          }
        }
      }
    },
    "domainId": {
      "description": "Domain UUID",
      "type": "string"
    }
  },
  "required": [
    "name",
    "defaultAction"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PUT/v11_1/l3AccessControlPolicies/{id}

Modify a L3 Access Control Policy.

Request
HideShow
Body
{
  "name": "L3 Access Control policy",
  "description": "l3 description",
  "l3AclRuleList": [
    {
      "priority": 1,
      "description": "Allow DNS",
      "ipType": "IPv6",
      "enableSourceV6Prefix": true,
      "sourceIpV6": "",
      "action": "ALLOW",
      "direction": "INBOUND"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the L3 Access Control Policy",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the L3 Access Control Policy",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "defaultAction": {
      "description": "Default action",
      "type": "string",
      "enum": [
        "BLOCK",
        "ALLOW"
      ]
    },
    "l3AclRuleList": {
      "type": "array",
      "description": "L3 access control list",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "type": "integer",
            "description": "Priority"
          },
          "description": {
            "description": "Description of the traffic access control rule",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "ipType": {
            "description": "IP Type(IPv4 or IPv6).",
            "default": "IPv4",
            "type": "string",
            "enum": [
              "IPv4",
              "IPv6"
            ]
          },
          "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"
          },
          "enableSourceV6Prefix": {
            "description": "Enable Source IPv6 prefix.",
            "type": "boolean"
          },
          "sourceIpV6": {
            "type": "string",
            "description": "Source IPv6 Address."
          },
          "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"
          },
          "enableDestinationV6Prefix": {
            "description": "Enable Destination IPv6 prefix.",
            "type": "boolean"
          },
          "destinationIpV6": {
            "type": "string",
            "description": "Destination IPv6 Address."
          },
          "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.",
            "type": "string",
            "enum": [
              "TCP",
              "UDP",
              "UDPLITE",
              "ICMP_ICMPV4",
              "ICMPV6",
              "IGMP",
              "ESP",
              "AH",
              "SCTP",
              "CUSTOM"
            ]
          },
          "customProtocol": {
            "type": "integer",
            "minimum": 1,
            "maximum": 255,
            "description": "The protocol of traffic access control. Available if the protocol is set to CUSTOM."
          },
          "action": {
            "description": "The access of traffic access control.",
            "default": "ALLOW",
            "type": "string",
            "enum": [
              "ALLOW",
              "BLOCK"
            ]
          },
          "direction": {
            "description": "The direction of traffic access control.",
            "default": "INBOUND",
            "type": "string",
            "enum": [
              "INBOUND",
              "OUTBOUND",
              "DUAL"
            ]
          }
        }
      }
    },
    "domainId": {
      "description": "Domain UUID",
      "type": "string"
    }
  },
  "required": [
    "name",
    "defaultAction"
  ]
}
Response  204

Delete

DELETE/v11_1/l3AccessControlPolicies/{id}

Delete a L3 Access Control Policy.

Response  204

Bulk Delete

DELETE/v11_1/l3AccessControlPolicies

Use this API command to delete Bulk L3 Access Control Policies.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

L2 Access Control

Retrieve List

GET/v11_1/rkszones/{zoneId}/l2ACL

Retrieve a list of L2 Access Control (for Firmware Versions less than 5.2).

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

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

Retrieve

GET/v11_1/rkszones/{zoneId}/l2ACL/{id}

Retrieve an L2 Access Control (for Firmware Versions less than 5.2).

Response  200
HideShow
Body
{
  "name": "l2acl_name",
  "id": "128a26b0-ab73-11e4-87f2-000c29c1611c",
  "description": "l2acl_desc",
  "zoneId": "f4c2fbf6-7f94-44f2-a509-5308db165891",
  "restriction": "ALLOW",
  "ruleMacs": [
    "33:11:11:11:11:12",
    "22:11:11:11:11:11"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "identifier of the L2 Access Control",
      "type": "string"
    },
    "zoneId": {
      "description": "identifier of the zone which the L2 Access Control belongs to",
      "type": "string"
    },
    "name": {
      "description": "name of the L2 Access Control",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the L2 Access Control",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "restriction": {
      "description": "restriction of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    },
    "ruleMacs": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
      }
    }
  }
}

Retrieve L2 AccessControl Profile List

POST/v11_1/query/services/l2AccessControl

Query L2 AccessControl Profiles with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Create

POST/v11_1/rkszones/{zoneId}/l2ACL

Create a new L2 Access Control (for Firmware Versions less than 5.2).

Request
HideShow
Body
{
  "name": "l2acl_create_name",
  "description": "l2acl_create_desc",
  "restriction": "ALLOW",
  "ruleMacs": [
    "55:11:11:11:11:12",
    "66:11:11:11:11:11"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "name of the L2 Access Control",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the L2 Access Control",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "restriction": {
      "description": "restriction of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    },
    "ruleMacs": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
      }
    }
  },
  "required": [
    "name",
    "restriction"
  ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v11_1/rkszones/{zoneId}/l2ACL/{id}

Modify a specific L2 Access Control basic (for Firmware Versions less than 5.2).

Request
HideShow
Body
{
  "name": "l2acl_modify_name",
  "description": "l2acl_modify_desc",
  "restriction": "BLOCK",
  "ruleMacs": [
    "55:11:11:11:11:12",
    "66:11:11:11:11:11"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "name of the L2 Access Control",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the L2 Access Control",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "restriction": {
      "description": "restriction of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    },
    "ruleMacs": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
      }
    }
  }
}
Response  204

Delete

DELETE/v11_1/rkszones/{zoneId}/l2ACL/{id}

Delete an L2 Access Control (for Firmware Versions less than 5.2).

Response  204

Device Policy

Retrieve

GET/v11_1/rkszones/{zoneId}/devicePolicy/{id}

Retrieve a Device Policy Profile (for Firmware Versions less than 5.2).

Response  200
HideShow
Body
{
  "id": "c9df9310-0ac0-11e6-9411-56847afe9799",
  "name": "devicepolic-2",
  "description": "devicepolicDesc",
  "defaultAction": "ALLOW",
  "rule": [
    {
      "description": "ruleOne",
      "deviceType": "Windows",
      "uplink": 0.1,
      "downlink": 2.25,
      "vlan": null,
      "action": "ALLOW"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "identifier of the device policy config",
      "type": "string"
    },
    "name": {
      "description": "name of the device policy config",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the device policy config",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "defaultAction": {
      "description": "defaultAction of the device policy config",
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    },
    "rule": {
      "type": "array",
      "description": "rule of the device policy config",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "description": {
            "description": "description of the device policy rule",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "deviceType": {
            "description": "deviceType of the device policy rule",
            "type": "string",
            "enum": [
              "Windows",
              "Android",
              "Apple_iOS",
              "Mac_OS",
              "Linux",
              "VoIP",
              "Gaming",
              "Printers",
              "BlackBerry",
              "Chrome_OS"
            ]
          },
          "uplink": {
            "description": "uplink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75,  7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75,  9.00, 9.25, 9.50, 9.75,  10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
            "type": "number",
            "minimum": 0,
            "maximum": 20
          },
          "downlink": {
            "description": "downlink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75,  7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75,  9.00, 9.25, 9.50, 9.75,  10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
            "type": "number",
            "minimum": 0,
            "maximum": 20
          },
          "vlan": {
            "description": "VLAN Members of the ethernet port profile",
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 4094
          },
          "action": {
            "description": "defaultAction of the device policy config",
            "type": "string",
            "enum": [
              "ALLOW",
              "BLOCK"
            ]
          }
        }
      }
    }
  }
}

Retrieve List

GET/v11_1/rkszones/{zoneId}/devicePolicy

Retrieve a list of Device Policy Profiles within a zone (for Firmware Versions less than 5.2).

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "a2df9310-0ac0-11e6-9411-56847afe9799",
      "name": "devicepolic-1"
    },
    {
      "id": "c9df9310-0ac0-11e6-9411-56847afe9799",
      "name": "devicepolic-2"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the service",
            "type": "string"
          },
          "name": {
            "description": "Name of the service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          }
        }
      }
    }
  }
}

Retrieve Device Policy Profile List

POST/v11_1/query/services/devicePolicy

Query Device Policy Profiles with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Create

POST/v11_1/rkszones/{zoneId}/devicePolicy

Create a new Device Policy Profile (for Firmware Versions less than 5.2).

Request
HideShow
Body
{
  "name": "devicepolic",
  "description": "devicepolicDesc",
  "defaultAction": "ALLOW"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "name of the device policy config",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the device policy config",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "defaultAction": {
      "description": "defaultAction of the device policy config",
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    }
  },
  "required": [
    "name",
    "defaultAction"
  ]
}
Response  201
HideShow
Body
{
  "id": "a2df9310-0ac0-11e6-9411-56847afe9799"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v11_1/rkszones/{zoneId}/devicePolicy/{id}

Modify a specific Device Policy Profile (for Firmware Versions less than 5.2).

Request
HideShow
Body
{
  "name": "devicepolic",
  "description": "devicepolicDesc",
  "defaultAction": "ALLOW",
  "rule": [
    {
      "description": "ruleOne",
      "deviceType": "Windows",
      "uplink": 19,
      "downlink": 2.25,
      "vlan": null,
      "action": "ALLOW"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "name of the device policy config",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the device policy config",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "defaultAction": {
      "description": "defaultAction of the device policy config",
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    },
    "rule": {
      "type": "array",
      "description": "rule of the device policy config",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "description": {
            "description": "description of the device policy rule",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "deviceType": {
            "description": "deviceType of the device policy rule",
            "type": "string",
            "enum": [
              "Windows",
              "Android",
              "Apple_iOS",
              "Mac_OS",
              "Linux",
              "VoIP",
              "Gaming",
              "Printers",
              "BlackBerry",
              "Chrome_OS"
            ]
          },
          "uplink": {
            "description": "uplink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75,  7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75,  9.00, 9.25, 9.50, 9.75,  10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
            "type": "number",
            "minimum": 0,
            "maximum": 20
          },
          "downlink": {
            "description": "downlink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75,  7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75,  9.00, 9.25, 9.50, 9.75,  10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
            "type": "number",
            "minimum": 0,
            "maximum": 20
          },
          "vlan": {
            "description": "VLAN Members of the ethernet port profile",
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 4094
          },
          "action": {
            "description": "defaultAction of the device policy config",
            "type": "string",
            "enum": [
              "ALLOW",
              "BLOCK"
            ]
          }
        }
      }
    }
  }
}
Response  204

Delete

DELETE/v11_1/rkszones/{zoneId}/devicePolicy/{id}

Delete Device Policy Profile (for Firmware Versions less than 5.2).

Response  204

Device Policy in Domain Level

Retrieve

GET/v11_1/devicePolicy/{id}

Use this API command to retrieve a Device Policy profile.

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "identifier of the device policy config",
      "type": "string"
    },
    "name": {
      "description": "name of the device policy config",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the device policy config",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "defaultAction": {
      "description": "defaultAction of the device policy config",
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    },
    "rule": {
      "type": "array",
      "description": "rule of the device policy config",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "description": {
            "description": "description of the device policy rule",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "deviceType": {
            "description": "deviceType of the device policy rule",
            "type": "string"
          },
          "osVendor": {
            "description": "osVendor of the device policy rule",
            "type": "string"
          },
          "uplink": {
            "description": "uplink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75,  7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75,  9.00, 9.25, 9.50, 9.75,  10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
            "type": "number",
            "minimum": 0,
            "maximum": 200
          },
          "downlink": {
            "description": "downlink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75,  7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75,  9.00, 9.25, 9.50, 9.75,  10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
            "type": "number",
            "minimum": 0,
            "maximum": 200
          },
          "vlan": {
            "description": "VLAN Members of the ethernet port profile",
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 4094
          },
          "action": {
            "description": "defaultAction of the device policy config",
            "type": "string",
            "enum": [
              "ALLOW",
              "BLOCK"
            ]
          }
        }
      }
    }
  }
}

Retrieve List

GET/v11_1/devicePolicy

Use this API command to retrieve list of Device Policy profiles.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

domainId
string (optional) 

Domain id for query

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the service",
            "type": "string"
          },
          "name": {
            "description": "Name of the service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          }
        }
      }
    }
  }
}

Retrieve Device Policy Profile List

POST/v11_1/devicePolicy/query

Query Device Policy Profile with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "rawDataTotalCount": {
      "description": "Total device policy count",
      "type": "integer"
    },
    "totalCount": {
      "description": "Current page device policy count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates if there are more device policy after the currently displayed list",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first device policy returned out of the complete device policy list",
      "type": "integer"
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "identifier of the device policy config",
            "type": "string"
          },
          "name": {
            "description": "name of the device policy config",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "description of the device policy config",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "defaultAction": {
            "description": "defaultAction of the device policy config",
            "type": "string",
            "enum": [
              "ALLOW",
              "BLOCK"
            ]
          },
          "rule": {
            "type": "array",
            "description": "rule of the device policy config",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "description": {
                  "description": "description of the device policy rule",
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 64
                },
                "deviceType": {
                  "description": "deviceType of the device policy rule",
                  "type": "string"
                },
                "osVendor": {
                  "description": "osVendor of the device policy rule",
                  "type": "string"
                },
                "uplink": {
                  "description": "uplink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75,  7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75,  9.00, 9.25, 9.50, 9.75,  10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
                  "type": "number",
                  "minimum": 0,
                  "maximum": 200
                },
                "downlink": {
                  "description": "downlink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75,  7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75,  9.00, 9.25, 9.50, 9.75,  10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
                  "type": "number",
                  "minimum": 0,
                  "maximum": 200
                },
                "vlan": {
                  "description": "VLAN Members of the ethernet port profile",
                  "type": [
                    "integer",
                    "null"
                  ],
                  "minimum": 1,
                  "maximum": 4094
                },
                "action": {
                  "description": "defaultAction of the device policy config",
                  "type": "string",
                  "enum": [
                    "ALLOW",
                    "BLOCK"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

Create

POST/v11_1/devicePolicy

Use this API command to create a Device Policy profile.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "name of the device policy config",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the device policy config",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "defaultAction": {
      "description": "defaultAction of the device policy config",
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    },
    "rule": {
      "type": "array",
      "description": "rule of the device policy config",
      "minItems": 1,
      "maxItems": 32,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "description": {
            "description": "description of the device policy rule",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "deviceType": {
            "description": "deviceType of the device policy rule",
            "type": "string"
          },
          "osVendor": {
            "description": "osVendor of the device policy rule",
            "type": "string"
          },
          "uplink": {
            "description": "uplink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75,  7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75,  9.00, 9.25, 9.50, 9.75,  10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
            "type": "number",
            "minimum": 0,
            "maximum": 200
          },
          "downlink": {
            "description": "downlink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75,  7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75,  9.00, 9.25, 9.50, 9.75,  10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
            "type": "number",
            "minimum": 0,
            "maximum": 200
          },
          "vlan": {
            "description": "VLAN Members of the ethernet port profile",
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 4094
          },
          "action": {
            "description": "defaultAction of the device policy config",
            "type": "string",
            "enum": [
              "ALLOW",
              "BLOCK"
            ]
          }
        }
      }
    },
    "domainId": {
      "description": "domainId of the device policy config",
      "type": "string"
    }
  },
  "required": [
    "name",
    "defaultAction",
    "rule"
  ]
}
Response  201
HideShow
Body
{
  "id": "05f0503b-cfd9-414e-b37d-72a96f0f4288"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PUT/v11_1/devicePolicy/{id}

Use this API command to update a Device Policy profile.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "name of the device policy config",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the device policy config",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "defaultAction": {
      "description": "defaultAction of the device policy config",
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    },
    "rule": {
      "type": "array",
      "description": "rule of the device policy config",
      "minItems": 1,
      "maxItems": 32,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "description": {
            "description": "description of the device policy rule",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "deviceType": {
            "description": "deviceType of the device policy rule",
            "type": "string"
          },
          "osVendor": {
            "description": "osVendor of the device policy rule",
            "type": "string"
          },
          "uplink": {
            "description": "uplink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75,  7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75,  9.00, 9.25, 9.50, 9.75,  10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
            "type": "number",
            "minimum": 0,
            "maximum": 200
          },
          "downlink": {
            "description": "downlink rate Limiting of the device policy rule, rate unit is mbps, value must include be 0, 0.10, 0.25, 0.50, 0.75, 1.00, 1.25,1.50, 1.75, 2.00, 2.25, 2.50, 2.75, 3.00, 3.20, 3.50, 3.75, 4.00, 4.25, 4.50, 4.75, 5.00, 5.25, 5.50, 5.75, 6.00, 6.25, 6.50, 6.75,  7.00, 7.25, 7.50, 7.75, 8.00, 8.25, 8.50, 8.75,  9.00, 9.25, 9.50, 9.75,  10.00, 10.25, 10.50, 10.75, 11.00, 11.25, 11.50, 11.75, 12.00, 12.25, 12.50, 12.75, 13.00, 13.25, 13.50, 13.75, 14.00, 14.25, 14.50, 14.75, 15.00, 15.25, 15.50, 15.75, 16.00, 16.25, 16.50, 16.75, 17.00, 17.25, 17.50, 17.75, 18.00, 18.25, 18.50, 18.75, 19.00, 19.25, 19.50, 19.75, 20.00",
            "type": "number",
            "minimum": 0,
            "maximum": 200
          },
          "vlan": {
            "description": "VLAN Members of the ethernet port profile",
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 4094
          },
          "action": {
            "description": "defaultAction of the device policy config",
            "type": "string",
            "enum": [
              "ALLOW",
              "BLOCK"
            ]
          }
        }
      }
    }
  }
}
Response  204

Delete

DELETE/v11_1/devicePolicy/{id}

Use this API command to delete a Device Policy profile.

Response  204

Bulk Delete

DELETE/v11_1/devicePolicy

Use this API command to delete a list of Device Policy profile.

Request
HideShow
Body
{
  "idList": [
    "eac50e51-4a63-11e7-a68a-0a0027000000",
    "1b4950d1-49d9-11e7-a68a-0a0027000000"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

DiffServ

Retrieve

GET/v11_1/rkszones/{zoneId}/diffserv/{id}

Use this API command to retrieve DiffServ profile.

Response  200
HideShow
Body
{
  "name": "DiffServ name",
  "description": "DiffServ description",
  "uplinkDiffServ": {
    "uplinkEnable": true,
    "uplink": "80"
  },
  "downlinkDiffServ": {
    "downlinkEnable": true,
    "downlink": "90"
  },
  "preservedList": [
    "20",
    "21",
    "22",
    "23",
    "24",
    "26"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the zone",
      "type": "string"
    },
    "name": {
      "description": "Name of the diffserv",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the diffserv",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "uplinkDiffServ": {
      "description": "Tunnel DiffServ - Set Uplink Diffserv",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "uplinkEnable": {
          "description": "Uplink enable",
          "type": "boolean"
        },
        "uplink": {
          "description": "Uplink",
          "type": "string"
        }
      }
    },
    "downlinkDiffServ": {
      "description": "Tunnel DiffServ - Set Downlink Diffserv",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "downlinkEnable": {
          "description": "Downlink enable",
          "type": "boolean"
        },
        "downlink": {
          "description": "Downlink",
          "type": "string"
        }
      }
    },
    "preservedList": {
      "type": "array",
      "description": "Preserved list",
      "items": {
        "type": "string"
      }
    }
  }
}

Retrieve list

GET/v11_1/rkszones/{zoneId}/diffserv

Use this API command to retrieve a list of DiffServ profile.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "510d26e1-05fd-11e6-bfc2-5254002b8a65",
      "name": "DiffServ name 1"
    },
    {
      "id": "556a6be0-0610-11e6-9de9-bad3cba0b410",
      "name": "DiffServ name 2"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the diff serv",
            "type": "string"
          },
          "name": {
            "description": "Name of the diff serv",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve DSCP Profile List

POST/v11_1/query/services/dscpProfile

Query DSCP Profiles with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Create

POST/v11_1/rkszones/{zoneId}/diffserv

Use this API command to create DiffServ profile.

Request
HideShow
Body
{
  "name": "DiffServ name",
  "description": "DiffServ description",
  "uplinkDiffServ": {
    "uplinkEnable": true,
    "uplink": "80"
  },
  "downlinkDiffServ": {
    "downlinkEnable": true,
    "downlink": "90"
  },
  "preservedList": [
    "20",
    "21",
    "22",
    "23",
    "24",
    "26"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the diffserv",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the diffserv",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "uplinkDiffServ": {
      "description": "Tunnel DiffServ - Set Uplink Diffserv",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "uplinkEnable": {
          "description": "Uplink enable",
          "type": "boolean"
        },
        "uplink": {
          "description": "Uplink",
          "type": "string"
        }
      }
    },
    "downlinkDiffServ": {
      "description": "Tunnel DiffServ - Set Downlink Diffserv",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "downlinkEnable": {
          "description": "Downlink enable",
          "type": "boolean"
        },
        "downlink": {
          "description": "Downlink",
          "type": "string"
        }
      }
    },
    "preservedList": {
      "type": "array",
      "description": "Preserved list",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": "0a6987e0-cedd-11e4-8148-f0def13d5845"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v11_1/rkszones/{zoneId}/diffserv/{id}

Use this API command to modify the configuration of DiffServ profile.

Request
HideShow
Body
{
  "name": "DiffServ name",
  "description": "DiffServ description",
  "uplinkDiffServ": {
    "uplinkEnable": true,
    "uplink": "80"
  },
  "downlinkDiffServ": {
    "downlinkEnable": true,
    "downlink": "90"
  },
  "preservedList": [
    "20",
    "21",
    "22",
    "23",
    "24",
    "26"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the diffserv",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the diffserv",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "uplinkDiffServ": {
      "description": "Tunnel DiffServ - Set Uplink Diffserv",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "uplinkEnable": {
          "description": "Uplink enable",
          "type": "boolean"
        },
        "uplink": {
          "description": "Uplink",
          "type": "string"
        }
      }
    },
    "downlinkDiffServ": {
      "description": "Tunnel DiffServ - Set Downlink Diffserv",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "downlinkEnable": {
          "description": "Downlink enable",
          "type": "boolean"
        },
        "downlink": {
          "description": "Downlink",
          "type": "string"
        }
      }
    },
    "preservedList": {
      "type": "array",
      "description": "Preserved list",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "name"
  ]
}
Response  204

Delete

DELETE/v11_1/rkszones/{zoneId}/diffserv/{id}

Use this API command to delete DiffServ profile.

Response  204

DHCP

Get AP DHCP Pool Usage by pool's index.

GET/v11_1/dhcpData/dhcpPools/{apMac}/{poolIndex}

Use this API command to get AP DHCP Pool Usage by pool’s index.

Response  200
HideShow
Body
{
  "poolIndex": "0",
  "vlanId": "80",
  "namd": "Pool80",
  "poolStartIp": "192.168.80.1",
  "poolEndIp": "192.168.80.100",
  "subnetMask": "255.255.255.0",
  "apIp": "192.168.80.1",
  "totalIpCount": 90,
  "usedIpCount": 3,
  "availableIpCount": 87,
  "clientInfoList": {
    "totalCount": 3,
    "hasMore": false,
    "firstIndex": 0,
    "list": [
      {
        "clientMac": "E2-EE-95-D4-2B-A7",
        "clientIp": "192.168.80.11",
        "leaseTime": 300,
        "leaseTimeHours": 0,
        "leaseTimeMinutes": 5,
        "leaseExpirtyTime": 1483016168
      },
      {
        "clientMac": "E2-E7-65-C5-07-C5",
        "clientIp": "192.168.80.12",
        "leaseTime": 3600,
        "leaseTimeHours": 1,
        "leaseTimeMinutes": 0,
        "leaseExpirtyTime": 1483016168
      },
      {
        "clientMac": "E2-9A-BD-A5-4A-F6",
        "clientIp": "192.168.80.13",
        "leaseTime": 360,
        "leaseTimeHours": 0,
        "leaseTimeMinutes": 6,
        "leaseExpirtyTime": 1483016168
      }
    ]
  }
}
Schema
{
  "type": "object",
  "description": "DHCP Pool Information List",
  "additionalProperties": false,
  "properties": {
    "poolIndex": {
      "type": "integer"
    },
    "vlanId": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "poolStartIp": {
      "type": "string"
    },
    "poolEndIp": {
      "type": "string"
    },
    "subnetMask": {
      "type": "string"
    },
    "apIp": {
      "type": "string"
    },
    "totalIpCount": {
      "type": "integer"
    },
    "usedIpCount": {
      "type": "integer"
    },
    "availableIpCount": {
      "type": "integer"
    },
    "clientInfoList": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "totalCount": {
          "type": "integer"
        },
        "hasMore": {
          "type": "boolean"
        },
        "firstIndex": {
          "type": "integer"
        },
        "list": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "DHCP Pool Client Information List",
            "additionalProperties": false,
            "properties": {
              "clientMac": {
                "type": "string"
              },
              "clientIp": {
                "type": "string"
              },
              "leaseTime": {
                "type": "integer"
              },
              "leaseTimeHours": {
                "type": "integer"
              },
              "leaseTimeMinutes": {
                "type": "integer"
              },
              "leaseExpiryTime": {
                "type": "integer"
              }
            }
          }
        }
      }
    }
  }
}

Get AP DHCP Message Statistic Usage.

GET/v11_1/dhcpData/dhcpMsgStats/{apMac}

Use this API command to get AP DHCP Message Statistic.

Response  200
HideShow
Body
{
  "id": "9c385e78-3edd-4833-b147-370e55801331",
  "tenantId": "38d7120d-bd8c-4bdf-9b9e-075e8b194d7b",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "apMac": "EC:8C:A2:01:C5:B0",
  "dhcpMsgRecvdStats": {
    "dhcpDiscover": 20500,
    "dhcpRequest": 0,
    "dhcpDecline": 650,
    "dhcpRelease": 33280,
    "dhcpInform": 23510
  },
  "dhcpMsgSentStats": {
    "dhcpOffer": 20800,
    "dhcpAck": 665008,
    "dhcpNak": 252
  }
}
Schema
{
  "type": "object",
  "description": "DHCP Message Statistic Per AP",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ]
    },
    "tenantId": {
      "type": [
        "string",
        "null"
      ]
    },
    "domainId": {
      "type": [
        "string",
        "null"
      ]
    },
    "apMac": {
      "type": "string"
    },
    "dhcpMsgRecvdStats": {
      "type": "object",
      "description": "DHCP Message Received Statistic",
      "additionalProperties": false,
      "properties": {
        "dhcpDiscover": {
          "type": "integer"
        },
        "dhcpRequest": {
          "type": "integer"
        },
        "dhcpDecline": {
          "type": "integer"
        },
        "dhcpRelease": {
          "type": "integer"
        },
        "dhcpInform": {
          "type": "integer"
        }
      }
    },
    "dhcpMsgSentStats": {
      "type": "object",
      "description": "DHCP Message Sent Statistic",
      "additionalProperties": false,
      "properties": {
        "dhcpOffer": {
          "type": "integer"
        },
        "dhcpAck": {
          "type": "integer"
        },
        "dhcpNak": {
          "type": "integer"
        }
      }
    }
  }
}

Get AP DHCP Pools Usage.

GET/v11_1/dhcpData/dhcpPools/{apMac}

Use this API command to get AP DHCP Pools Usage.

Response  200
HideShow
Body
{
  "id": null,
  "tenantId": null,
  "domainId": null,
  "domainEntity": null,
  "apMac": "F6-59-42-EF-AE-5E",
  "poolInfoList": [
    {
      "poolIndex": "0",
      "vlanId": "10",
      "namd": "Pool10",
      "poolStartIp": "192.168.10.1",
      "poolEndIp": "192.168.10.100",
      "subnetMask": "255.255.255.0",
      "apIp": "192.168.10.1",
      "totalIpCount": 90,
      "usedIpCount": 3,
      "availableIpCount": 87,
      "clientInfoList": {
        "totalCount": 3,
        "hasMore": false,
        "firstIndex": 0,
        "list": [
          {
            "clientMac": "A2-17-56-E1-F4-EA",
            "clientIp": "192.168.10.11",
            "leaseTime": 300,
            "leaseTimeHours": 0,
            "leaseTimeMinutes": 5,
            "leaseExpirtyTime": 1483016168
          },
          {
            "clientMac": "A2-B5-87-DF-AC-98",
            "clientIp": "192.168.10.12",
            "leaseTime": 3600,
            "leaseTimeHours": 1,
            "leaseTimeMinutes": 0,
            "leaseExpirtyTime": 1483016168
          },
          {
            "clientMac": "A2-3D-62-15-8A-ED",
            "clientIp": "192.168.10.13",
            "leaseTime": 360,
            "leaseTimeHours": 0,
            "leaseTimeMinutes": 6,
            "leaseExpirtyTime": 1483016168
          }
        ]
      }
    },
    {
      "poolIndex": "1",
      "vlanId": "20",
      "namd": "Pool20",
      "poolStartIp": "192.168.20.1",
      "poolEndIp": "192.168.20.100",
      "subnetMask": "255.255.255.0",
      "apIp": "192.168.20.1",
      "totalIpCount": 90,
      "usedIpCount": 3,
      "availableIpCount": 87,
      "clientInfoList": {
        "totalCount": 3,
        "hasMore": false,
        "firstIndex": 0,
        "list": [
          {
            "clientMac": "B2-8B-07-26-D5-8E",
            "clientIp": "192.168.20.11",
            "leaseTime": 300,
            "leaseTimeHours": 0,
            "leaseTimeMinutes": 5,
            "leaseExpirtyTime": 1483016168
          },
          {
            "clientMac": "B2-13-A0-66-36-A0",
            "clientIp": "192.168.20.12",
            "leaseTime": 3600,
            "leaseTimeHours": 1,
            "leaseTimeMinutes": 0,
            "leaseExpirtyTime": 1483016168
          },
          {
            "clientMac": "B2-6A-C8-EA-3D-E1",
            "clientIp": "192.168.20.13",
            "leaseTime": 360,
            "leaseTimeHours": 0,
            "leaseTimeMinutes": 6,
            "leaseExpirtyTime": 1483016168
          }
        ]
      }
    },
    {
      "poolIndex": "2",
      "vlanId": "30",
      "namd": "Pool30",
      "poolStartIp": "192.168.30.1",
      "poolEndIp": "192.168.30.100",
      "subnetMask": "255.255.255.0",
      "apIp": "192.168.30.1",
      "totalIpCount": 90,
      "usedIpCount": 3,
      "availableIpCount": 87,
      "clientInfoList": {
        "totalCount": 3,
        "hasMore": false,
        "firstIndex": 0,
        "list": [
          {
            "clientMac": "C2-38-C5-43-52-EA",
            "clientIp": "192.168.30.11",
            "leaseTime": 300,
            "leaseTimeHours": 0,
            "leaseTimeMinutes": 5,
            "leaseExpirtyTime": 1483016168
          },
          {
            "clientMac": "C2-09-06-47-D1-14",
            "clientIp": "192.168.30.12",
            "leaseTime": 3600,
            "leaseTimeHours": 1,
            "leaseTimeMinutes": 0,
            "leaseExpirtyTime": 1483016168
          },
          {
            "clientMac": "C2-6B-8B-50-07-7B",
            "clientIp": "192.168.30.13",
            "leaseTime": 360,
            "leaseTimeHours": 0,
            "leaseTimeMinutes": 6,
            "leaseExpirtyTime": 1483016168
          }
        ]
      }
    },
    {
      "poolIndex": "3",
      "vlanId": "40",
      "namd": "Pool40",
      "poolStartIp": "192.168.40.1",
      "poolEndIp": "192.168.40.100",
      "subnetMask": "255.255.255.0",
      "apIp": "192.168.40.1",
      "totalIpCount": 90,
      "usedIpCount": 3,
      "availableIpCount": 87,
      "clientInfoList": {
        "totalCount": 3,
        "hasMore": false,
        "firstIndex": 0,
        "list": [
          {
            "clientMac": "D2-C7-1B-FD-B0-C0",
            "clientIp": "192.168.40.11",
            "leaseTime": 300,
            "leaseTimeHours": 0,
            "leaseTimeMinutes": 5,
            "leaseExpirtyTime": 1483016168
          },
          {
            "clientMac": "D2-CB-C3-26-75-3E",
            "clientIp": "192.168.40.12",
            "leaseTime": 3600,
            "leaseTimeHours": 1,
            "leaseTimeMinutes": 0,
            "leaseExpirtyTime": 1483016168
          },
          {
            "clientMac": "D2-DE-89-23-EB-03",
            "clientIp": "192.168.40.13",
            "leaseTime": 360,
            "leaseTimeHours": 0,
            "leaseTimeMinutes": 6,
            "leaseExpirtyTime": 1483016168
          }
        ]
      }
    }
  ]
}
Schema
{
  "type": "object",
  "description": "DHCP Pools Usage Per AP",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ]
    },
    "tenantId": {
      "type": [
        "string",
        "null"
      ]
    },
    "domainId": {
      "type": [
        "string",
        "null"
      ]
    },
    "domainEntity": {
      "type": [
        "string",
        "null"
      ]
    },
    "apMac": {
      "type": "string"
    },
    "poolInfoList": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "DHCP Pool Information List",
        "additionalProperties": false,
        "properties": {
          "poolIndex": {
            "type": "integer"
          },
          "vlanId": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "poolStartIp": {
            "type": "string"
          },
          "poolEndIp": {
            "type": "string"
          },
          "subnetMask": {
            "type": "string"
          },
          "apIp": {
            "type": "string"
          },
          "totalIpCount": {
            "type": "integer"
          },
          "usedIpCount": {
            "type": "integer"
          },
          "availableIpCount": {
            "type": "integer"
          },
          "clientInfoList": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "totalCount": {
                "type": "integer"
              },
              "hasMore": {
                "type": "boolean"
              },
              "firstIndex": {
                "type": "integer"
              },
              "list": {
                "type": "array",
                "items": {
                  "type": "object",
                  "description": "DHCP Pool Client Information List",
                  "additionalProperties": false,
                  "properties": {
                    "clientMac": {
                      "type": "string"
                    },
                    "clientIp": {
                      "type": "string"
                    },
                    "leaseTime": {
                      "type": "integer"
                    },
                    "leaseTimeHours": {
                      "type": "integer"
                    },
                    "leaseTimeMinutes": {
                      "type": "integer"
                    },
                    "leaseExpiryTime": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Get DHCP Pool by Pool's ID

GET/v11_1/rkszones/{zoneId}/dhcpSite/dhcpProfile/{id}

Use this API command to get DHCP Pool by pool’s ID.

Response  200
HideShow
Body
{
  "id": "75e26590-547f-11e6-9ca7-5a095364c13c",
  "name": "dppf_01",
  "description": "dppf_01",
  "vlanId": 10,
  "subnetNetworkIp": "10.2.2.0",
  "subnetMask": "255.255.255.0",
  "poolStartIp": "10.2.2.1",
  "poolEndIp": "10.2.2.254",
  "primaryDnsIp": "2.2.2.2",
  "secondaryDnsIp": "8.8.8.8",
  "leaseTimeHours": 24,
  "leaseTimeMinutes": 0
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "zoneId": {
      "description": "Zone Id of DHCP Profile",
      "type": "string"
    },
    "id": {
      "description": "Identifier of the DHCP Profile",
      "type": "string"
    },
    "name": {
      "description": "Name of the DHCP Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the DHCP Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "vlanId": {
      "description": "VLAN ID of the DHCP Profile",
      "type": "integer",
      "minimum": 1,
      "maximum": 4094
    },
    "subnetNetworkIp": {
      "description": "Subnet Network IP of the DHCP Profile",
      "type": "string"
    },
    "subnetMask": {
      "description": "Subnet Mask of the DHCP Profile",
      "type": "string"
    },
    "poolStartIp": {
      "description": "Pool Starting IP of the DHCP Profile",
      "type": "string"
    },
    "poolEndIp": {
      "description": "Pool Ending IP of the DHCP Profile",
      "type": "string"
    },
    "primaryDnsIp": {
      "description": "Primany DNS IP of the DHCP Profile",
      "type": "string"
    },
    "secondaryDnsIp": {
      "description": "Secondary DNS IP of the DHCP Profile",
      "type": "string"
    },
    "leaseTimeHours": {
      "description": "Lease time in hours of the DHCP Profile",
      "type": "integer",
      "minimum": 0,
      "maximum": 24
    },
    "leaseTimeMinutes": {
      "description": "Lease time in minutes of the DHCP Profile",
      "type": "integer",
      "minimum": 0,
      "maximum": 59
    }
  }
}

Get DHCP Pool list

GET/v11_1/rkszones/{zoneId}/dhcpSite/dhcpProfile

Use this API command to get DHCP Pool list.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "75e26590-547f-11e6-9ca7-5a095364c13c",
      "name": "dppf_01",
      "description": "dppf_01",
      "vlanId": 10,
      "subnetNetworkIp": "10.2.2.0",
      "subnetMask": "255.255.255.0",
      "poolStartIp": "10.2.2.1",
      "poolEndIp": "10.2.2.254",
      "primaryDnsIp": "2.2.2.2",
      "secondaryDnsIp": "8.8.8.8",
      "leaseTimeHours": 24,
      "leaseTimeMinutes": 0
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "zoneId": {
            "description": "Zone Id of DHCP Profile",
            "type": "string"
          },
          "id": {
            "description": "Identifier of the DHCP Profile",
            "type": "string"
          },
          "name": {
            "description": "Name of the DHCP Profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the DHCP Profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "vlanId": {
            "description": "VLAN ID of the DHCP Profile",
            "type": "integer",
            "minimum": 1,
            "maximum": 4094
          },
          "subnetNetworkIp": {
            "description": "Subnet Network IP of the DHCP Profile",
            "type": "string"
          },
          "subnetMask": {
            "description": "Subnet Mask of the DHCP Profile",
            "type": "string"
          },
          "poolStartIp": {
            "description": "Pool Starting IP of the DHCP Profile",
            "type": "string"
          },
          "poolEndIp": {
            "description": "Pool Ending IP of the DHCP Profile",
            "type": "string"
          },
          "primaryDnsIp": {
            "description": "Primany DNS IP of the DHCP Profile",
            "type": "string"
          },
          "secondaryDnsIp": {
            "description": "Secondary DNS IP of the DHCP Profile",
            "type": "string"
          },
          "leaseTimeHours": {
            "description": "Lease time in hours of the DHCP Profile",
            "type": "integer",
            "minimum": 0,
            "maximum": 24
          },
          "leaseTimeMinutes": {
            "description": "Lease time in minutes of the DHCP Profile",
            "type": "integer",
            "minimum": 0,
            "maximum": 59
          }
        }
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Get DHCP Configuration

GET/v11_1/rkszones/{zoneId}/dhcpSite/dhcpSiteConfig

Use this API command to get DHCP Configuration.

Response  200
HideShow
Body
{
  "siteEnabled": true,
  "portSelectionEnabled": false,
  "dwpdEnabled": false,
  "manualSelect": true,
  "siteMode": "EnableOnMultipleAPs",
  "siteAps": [
    {
      "apMac": "38:FF:36:00:0E:20",
      "apServerEnabled": true,
      "apGatewayEnabled": true
    },
    {
      "apMac": "58:FF:36:00:0E:20",
      "apServerEnabled": true,
      "apGatewayEnabled": true
    }
  ],
  "siteProfiles": [
    "75e26590-547f-11e6-9ca7-5a095364c13c",
    "869bb532-547f-11e6-9ca7-5a095364c13c"
  ]
}
Schema
{
  "description": "DHCP Site Configuration in Zone",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "zoneName": {
      "description": "DHCP Service Zone Name",
      "type": "string"
    },
    "zoneId": {
      "description": "Zone UUID",
      "type": "string"
    },
    "siteEnabled": {
      "description": "DHCP Service Enabling Status",
      "type": "boolean"
    },
    "portSelectionEnabled": {
      "description": "DHCP Port Selection Enabled",
      "type": "boolean"
    },
    "dwpdEnabled": {
      "description": "DHCP Service Dynamic WAN Port Detection",
      "type": "boolean"
    },
    "manualSelect": {
      "description": "DHCP Service AP Selection Mode",
      "type": "boolean"
    },
    "siteMode": {
      "description": "DHCP Service mode",
      "type": "string",
      "enum": [
        "EnableOnEachAPs",
        "EnableOnMultipleAPs",
        "EnableOnHierarchicalAPs"
      ]
    },
    "eth0ProfileId": {
      "type": "integer"
    },
    "eth1ProfileId": {
      "type": "integer"
    },
    "siteAps": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "DHCP Site selected APs",
        "additionalProperties": false,
        "properties": {
          "apMac": {
            "type": "string"
          },
          "apName": {
            "type": "string"
          },
          "apStatus": {
            "type": "string",
            "enum": [
              "Online",
              "Offline",
              "Flagged"
            ]
          },
          "apServerEnabled": {
            "type": "boolean"
          },
          "apServerPrimary": {
            "type": "boolean"
          },
          "apServerIp": {
            "type": "string"
          },
          "apGatewayIp": {
            "type": "string"
          },
          "apServerType": {
            "type": "string"
          }
        }
      }
    },
    "siteProfiles": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "zoneId": {
            "description": "Zone Id of DHCP Profile",
            "type": "string"
          },
          "id": {
            "description": "Identifier of the DHCP Profile",
            "type": "string"
          },
          "name": {
            "description": "Name of the DHCP Profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the DHCP Profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "vlanId": {
            "description": "VLAN ID of the DHCP Profile",
            "type": "integer",
            "minimum": 1,
            "maximum": 4094
          },
          "subnetNetworkIp": {
            "description": "Subnet Network IP of the DHCP Profile",
            "type": "string"
          },
          "subnetMask": {
            "description": "Subnet Mask of the DHCP Profile",
            "type": "string"
          },
          "poolStartIp": {
            "description": "Pool Starting IP of the DHCP Profile",
            "type": "string"
          },
          "poolEndIp": {
            "description": "Pool Ending IP of the DHCP Profile",
            "type": "string"
          },
          "primaryDnsIp": {
            "description": "Primany DNS IP of the DHCP Profile",
            "type": "string"
          },
          "secondaryDnsIp": {
            "description": "Secondary DNS IP of the DHCP Profile",
            "type": "string"
          },
          "leaseTimeHours": {
            "description": "Lease time in hours of the DHCP Profile",
            "type": "integer",
            "minimum": 0,
            "maximum": 24
          },
          "leaseTimeMinutes": {
            "description": "Lease time in minutes of the DHCP Profile",
            "type": "integer",
            "minimum": 0,
            "maximum": 59
          }
        }
      }
    }
  }
}

Create DHCP Pool

POST/v11_1/rkszones/{zoneId}/dhcpSite/dhcpProfile

Use this API command to create DHCP Pool.

Request
HideShow
Body
{
  "name": "dhcp profile-test",
  "description": "create description",
  "vlanId": 30,
  "subnetNetworkIp": "10.2.2.0",
  "subnetMask": "255.255.255.0",
  "poolStartIp": "10.2.2.1",
  "poolEndIp": "10.2.2.254",
  "primaryDnsIp": "2.2.2.2",
  "secondaryDnsIp": "8.8.8.8",
  "leaseTimeHours": 12,
  "leaseTimeMinutes": 30
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the DHCP Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the DHCP Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "vlanId": {
      "description": "VLAN ID of the DHCP Profile",
      "type": "integer",
      "minimum": 1,
      "maximum": 4094
    },
    "subnetNetworkIp": {
      "description": "Subnet Network IP of the DHCP Profile",
      "type": "string"
    },
    "subnetMask": {
      "description": "Subnet Mask of the DHCP Profile",
      "type": "string"
    },
    "poolStartIp": {
      "description": "Pool Starting IP of the DHCP Profile",
      "type": "string"
    },
    "poolEndIp": {
      "description": "Pool Ending IP of the DHCP Profile",
      "type": "string"
    },
    "primaryDnsIp": {
      "description": "Primany DNS IP of the DHCP Profile",
      "type": "string"
    },
    "secondaryDnsIp": {
      "description": "Secondary DNS IP of the DHCP Profile",
      "type": "string"
    },
    "leaseTimeHours": {
      "description": "Lease time in hours of the DHCP Profile",
      "type": "integer",
      "minimum": 0,
      "maximum": 24
    },
    "leaseTimeMinutes": {
      "description": "Lease time in minutes of the DHCP Profile",
      "type": "integer",
      "minimum": 0,
      "maximum": 59
    }
  },
  "required": [
    "name",
    "vlanId",
    "subnetNetworkIp",
    "subnetMask",
    "poolStartIp",
    "poolEndIp",
    "leaseTimeHours",
    "leaseTimeMinutes"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Retrieve DHCP/NAT service configuration within Domain

POST/v11_1/rkszones/services/dhcpSiteConfig/query

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

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator for filtering",
            "type": "string",
            "enum": [
              "eq"
            ]
          }
        },
        "required": [
          "type",
          "value"
        ]
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "VERSION"
            ]
          },
          "value": {
            "description": "Value for filtering",
            "type": "string"
          },
          "operator": {
            "description": "Operator for filtering",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        },
        "required": [
          "type",
          "value"
        ]
      }
    },
    "options": {
      "description": "Specified feature required information.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "zone_ipmode": {
          "description": "List the zones only with the specified IP Mode.",
          "type": "string",
          "enum": [
            "IPV4",
            "IPV6",
            "IPV4_IPV6"
          ]
        },
        "includeSharedResources": {
          "description": "Include the resources of parent domain as well while querying.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "zoneName": "Default Zone",
      "zoneId": "fce48fb7-8b89-49f6-8ce5-f52aecfc81ff",
      "siteEnabled": false,
      "portSelectionEnabled": false,
      "dwpdEnabled": false,
      "manualSelect": false,
      "siteMode": "EnableOnEachAPs",
      "siteProfiles": [],
      "siteAps": []
    },
    {
      "zoneName": "zoneK",
      "zoneId": "fce48fb7-eeb6-49f6-8ce5-525400f698b4",
      "siteEnabled": true,
      "portSelectionEnabled": false,
      "dwpdEnabled": false,
      "manualSelect": false,
      "siteMode": "EnableOnEachAPs",
      "siteProfiles": [
        {
          "id": "c1b60951-eeb6-11e6-850a-525400f698b4",
          "zoneId": "fce48fb7-8b89-49f6-8ce5-f52aecfc81ff",
          "name": "P01",
          "description": "",
          "vlanId": 10,
          "subnetNetworkIp": "192.168.10.0",
          "subnetMask": "255.255.255.0",
          "poolStartIp": "192.168.10.1",
          "poolEndIp": "192.168.10.100",
          "primaryDnsIp": "",
          "secondaryDnsIp": "",
          "leaseTimeHours": 0,
          "leaseTimeMinutes": 5
        }
      ],
      "siteAps": [
        {
          "apMac": "EC:8C:A2:01:C5:B0",
          "apServerEnabled": true,
          "apServerPrimary": true,
          "apServerIp": "192.168.10.1",
          "apGatewayIp": "192.168.10.1",
          "apName": "RuckusAP",
          "apStatus": "Offline"
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "zoneName": {
            "description": "DHCP Service Zone Name",
            "type": "string"
          },
          "zoneId": {
            "description": "Zone UUID",
            "type": "string"
          },
          "siteEnabled": {
            "description": "DHCP Service Enabling Status",
            "type": "boolean"
          },
          "portSelectionEnabled": {
            "description": "DHCP Port Selection Enabled",
            "type": "boolean"
          },
          "dwpdEnabled": {
            "description": "DHCP Service Dynamic WAN Port Detection",
            "type": "boolean"
          },
          "manualSelect": {
            "description": "DHCP Service AP Selection Mode",
            "type": "boolean"
          },
          "siteMode": {
            "description": "DHCP Service mode",
            "type": "string",
            "enum": [
              "EnableOnEachAPs",
              "EnableOnMultipleAPs",
              "EnableOnHierarchicalAPs"
            ]
          },
          "eth0ProfileId": {
            "type": "integer"
          },
          "eth1ProfileId": {
            "type": "integer"
          },
          "siteAps": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "DHCP Site selected APs",
              "additionalProperties": false,
              "properties": {
                "apMac": {
                  "type": "string"
                },
                "apName": {
                  "type": "string"
                },
                "apStatus": {
                  "type": "string",
                  "enum": [
                    "Online",
                    "Offline",
                    "Flagged"
                  ]
                },
                "apServerEnabled": {
                  "type": "boolean"
                },
                "apServerPrimary": {
                  "type": "boolean"
                },
                "apServerIp": {
                  "type": "string"
                },
                "apGatewayIp": {
                  "type": "string"
                },
                "apServerType": {
                  "type": "string"
                }
              }
            }
          },
          "siteProfiles": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "zoneId": {
                  "description": "Zone Id of DHCP Profile",
                  "type": "string"
                },
                "id": {
                  "description": "Identifier of the DHCP Profile",
                  "type": "string"
                },
                "name": {
                  "description": "Name of the DHCP Profile",
                  "type": "string",
                  "minLength": 2,
                  "maxLength": 32,
                  "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
                },
                "description": {
                  "description": "Description of the DHCP Profile",
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 64
                },
                "vlanId": {
                  "description": "VLAN ID of the DHCP Profile",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 4094
                },
                "subnetNetworkIp": {
                  "description": "Subnet Network IP of the DHCP Profile",
                  "type": "string"
                },
                "subnetMask": {
                  "description": "Subnet Mask of the DHCP Profile",
                  "type": "string"
                },
                "poolStartIp": {
                  "description": "Pool Starting IP of the DHCP Profile",
                  "type": "string"
                },
                "poolEndIp": {
                  "description": "Pool Ending IP of the DHCP Profile",
                  "type": "string"
                },
                "primaryDnsIp": {
                  "description": "Primany DNS IP of the DHCP Profile",
                  "type": "string"
                },
                "secondaryDnsIp": {
                  "description": "Secondary DNS IP of the DHCP Profile",
                  "type": "string"
                },
                "leaseTimeHours": {
                  "description": "Lease time in hours of the DHCP Profile",
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 24
                },
                "leaseTimeMinutes": {
                  "description": "Lease time in minutes of the DHCP Profile",
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 59
                }
              }
            }
          }
        }
      }
    }
  }
}

Retrieve DHCP/NAT service IP assignment

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

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

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

Retrieve DHCP Profile List

POST/v11_1/query/services/dhcpProfile

Query DHCP Profiles with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "75e26590-547f-11e6-9ca7-5a095364c13c",
      "name": "dppf_01",
      "description": "dppf_01",
      "vlanId": 10,
      "subnetNetworkIp": "10.2.2.0",
      "subnetMask": "255.255.255.0",
      "poolStartIp": "10.2.2.1",
      "poolEndIp": "10.2.2.254",
      "primaryDnsIp": "2.2.2.2",
      "secondaryDnsIp": "8.8.8.8",
      "leaseTimeHours": 24,
      "leaseTimeMinutes": 0
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "zoneId": {
            "description": "Zone Id of DHCP Profile",
            "type": "string"
          },
          "id": {
            "description": "Identifier of the DHCP Profile",
            "type": "string"
          },
          "name": {
            "description": "Name of the DHCP Profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the DHCP Profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "vlanId": {
            "description": "VLAN ID of the DHCP Profile",
            "type": "integer",
            "minimum": 1,
            "maximum": 4094
          },
          "subnetNetworkIp": {
            "description": "Subnet Network IP of the DHCP Profile",
            "type": "string"
          },
          "subnetMask": {
            "description": "Subnet Mask of the DHCP Profile",
            "type": "string"
          },
          "poolStartIp": {
            "description": "Pool Starting IP of the DHCP Profile",
            "type": "string"
          },
          "poolEndIp": {
            "description": "Pool Ending IP of the DHCP Profile",
            "type": "string"
          },
          "primaryDnsIp": {
            "description": "Primany DNS IP of the DHCP Profile",
            "type": "string"
          },
          "secondaryDnsIp": {
            "description": "Secondary DNS IP of the DHCP Profile",
            "type": "string"
          },
          "leaseTimeHours": {
            "description": "Lease time in hours of the DHCP Profile",
            "type": "integer",
            "minimum": 0,
            "maximum": 24
          },
          "leaseTimeMinutes": {
            "description": "Lease time in minutes of the DHCP Profile",
            "type": "integer",
            "minimum": 0,
            "maximum": 59
          }
        }
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Modify DHCP Profile by pool's ID

PATCH/v11_1/rkszones/{zoneId}/dhcpSite/dhcpProfile/{id}

Use this API command to modify DHCP Pool by pool’s ID.

Request
HideShow
Body
{
  "name": "dhcp profile-test",
  "description": "create description",
  "vlanId": 30,
  "subnetNetworkIp": "10.2.2.0",
  "subnetMask": "255.255.255.0",
  "poolStartIp": "10.2.2.1",
  "poolEndIp": "10.2.2.254",
  "primaryDnsIp": "2.2.2.2",
  "secondaryDnsIp": "8.8.8.8",
  "leaseTimeHours": 12,
  "leaseTimeMinutes": 30
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the DHCP Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the DHCP Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "vlanId": {
      "description": "VLAN ID of the DHCP Profile",
      "type": "integer",
      "minimum": 1,
      "maximum": 4094
    },
    "subnetNetworkIp": {
      "description": "Subnet Network IP of the DHCP Profile",
      "type": "string"
    },
    "subnetMask": {
      "description": "Subnet Mask of the DHCP Profile",
      "type": "string"
    },
    "poolStartIp": {
      "description": "Pool Starting IP of the DHCP Profile",
      "type": "string"
    },
    "poolEndIp": {
      "description": "Pool Ending IP of the DHCP Profile",
      "type": "string"
    },
    "primaryDnsIp": {
      "description": "Primany DNS IP of the DHCP Profile",
      "type": "string"
    },
    "secondaryDnsIp": {
      "description": "Secondary DNS IP of the DHCP Profile",
      "type": "string"
    },
    "leaseTimeHours": {
      "description": "Lease time in hours of the DHCP Profile",
      "type": "integer",
      "minimum": 0,
      "maximum": 24
    },
    "leaseTimeMinutes": {
      "description": "Lease time in minutes of the DHCP Profile",
      "type": "integer",
      "minimum": 0,
      "maximum": 59
    }
  },
  "required": [
    "name",
    "vlanId",
    "subnetNetworkIp",
    "subnetMask",
    "poolStartIp",
    "poolEndIp",
    "leaseTimeHours",
    "leaseTimeMinutes"
  ]
}
Response  204

Delete DHCP Pool by pool's ID

DELETE/v11_1/rkszones/{zoneId}/dhcpSite/dhcpProfile/{id}

Use this API command to delete DHCP Pool by pool’s ID.

Response  204

Delete multiple DHCP Pools

DELETE/v11_1/rkszones/{zoneId}/dhcpSite/dhcpProfile

Use this API command to delete multiple DHCP Pools.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Bonjour Gateway Policies

Retrieve

GET/v11_1/rkszones/{zoneId}/bonjourGateway/policies/{id}

Use this API command to retrieve bonjour gateway policy.

Response  200
HideShow
Body
{
  "name": "bonjour gateway policy name",
  "description": "bonjour gateway policy description",
  "bonjourPolicyRuleList": [
    {
      "priority": 1,
      "bridgeService": "AIRPLAY",
      "fromVlan": 15,
      "toVlan": 26,
      "notes": "notes"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Bonjour Gateway Policy",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Bonjour Gateway Policy",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "bonjourPolicyRuleList": {
      "type": "array",
      "description": "Bonjour policy rule list",
      "items": {
        "type": "object",
        "description": "Bonjour policy rule",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "description": "Priority",
            "type": "string"
          },
          "bridgeService": {
            "description": "Bridge service",
            "type": "string"
          },
          "protocol": {
            "description": "protocol",
            "type": "string"
          },
          "fromVlan": {
            "description": "From VLAN",
            "type": "integer"
          },
          "toVlan": {
            "description": "To VLAN",
            "type": "integer"
          },
          "notes": {
            "description": "Notes",
            "type": "string",
            "maximum": 180
          }
        }
      }
    }
  }
}

Retrieve list

GET/v11_1/rkszones/{zoneId}/bonjourGateway/policies

Use this API command to retrieve a list of bonjour gateway policies.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "510d26e1-05fd-11e6-bfc2-5254002b8a65",
      "name": "Bonjour gateway policy name 1",
      "description": "Bonjour gateway policy description",
      "lastModifiedBy": "user name",
      "lastModifiedOn": "2016/07/12 14:38:43"
    },
    {
      "id": "556a6be0-0610-11e6-9de9-bad3cba0b410",
      "name": "Bonjour gateway policy name 2",
      "description": "Bonjour gateway policy description",
      "lastModifiedBy": "user name",
      "lastModifiedOn": "2016/07/12 14:38:43"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the bonjour gateway policy",
            "type": "string"
          },
          "name": {
            "description": "Name of the bonjour gateway policy",
            "type": "string"
          },
          "description": {
            "description": "Description of the bonjour gateway policy",
            "type": "string"
          },
          "lastModifiedBy": {
            "description": "Last modified user of the bonjour gateway policy",
            "type": "string"
          },
          "lastModifiedOn": {
            "description": "Last modified time of the bonjour gateway policy",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve bonjourPolicy Profile List

POST/v11_1/query/services/bonjourPolicy

Query bonjourPolicy Profiles with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Create

POST/v11_1/rkszones/{zoneId}/bonjourGateway/policies

Use this API command to create bonjour gateway policy.

Request
HideShow
Body
{
  "name": "bonjour gateway policy name",
  "description": "bonjour gateway policy description",
  "bonjourPolicyRuleList": [
    {
      "bridgeService": "ITUNES_REMOTE",
      "fromVlan": 1,
      "toVlan": 10,
      "notes": "notes"
    }
  ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the Bonjour Gateway Policy",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Bonjour Gateway Policy",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bonjourPolicyRuleList" : {
            "type" : "array",
            "description" : "Bonjour policy rule list",
            "items" : {
                "type" : "object",
                "description" : "Bonjour policy rule",
                "additionalProperties" : false,
                "properties" : {
                    "bridgeService" : {
                        "description" : "Bonjour Service Type",
                        "type" : "string",
                        "enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "GOOGLE_CHROMECAST", "OTHER" ]
                    },
                    "protocol" : {
                        "description" : "protocol. This is only available when bridgeService is OTHER",
                        "type" : "string",
                        "pattern" : "^(_[!-~]([ -~]){0,63}[!-~]\._tcp\.)|(_[!-~]([ -~]){0,63}[!-~]\._udp\.)$"
                    },
                    "fromVlan" : {
                        "description" : "From VLAN",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 4094
                    },
                    "toVlan" : {
                        "description" : "To VLAN",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 4094
                    },
                    "notes" : {
                        "description" : "Notes",
                        "type" : "string",
                        "maximum" : 180
                    }
                },
                "required" : [ "bridgeService", "fromVlan", "toVlan" ]
            }
        }
    },
    "required" : [ "name" ]
}
Response  201
HideShow
Body
{
  "id": "0a6987e0-cedd-11e4-8148-f0def13d5845"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Enable

POST/v11_1/rkszones/{zoneId}/bonjourGateway/enable

Use this API command to enable/disable bonjour gateway policy.

Request
HideShow
Body
{
  "enabledBonjourGateway": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enabledBonjourGateway": {
      "description": "Enable Bonjour gateway on th AP",
      "type": "boolean"
    }
  },
  "required": [
    "enabledBonjourGateway"
  ]
}
Response  204

Modify

PATCH/v11_1/rkszones/{zoneId}/bonjourGateway/policies/{id}

Use this API command to modify the configuration of bonjour gateway policy.

Request
HideShow
Body
{
  "name": "bonjour gateway policy name",
  "description": "bonjour gateway policy description",
  "bonjourPolicyRuleList": [
    {
      "bridgeService": "AIRPLAY",
      "fromVlan": 15,
      "toVlan": 26,
      "notes": "notes"
    }
  ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the Bonjour Gateway Policy",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Bonjour Gateway Policy",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bonjourPolicyRuleList" : {
            "type" : "array",
            "description" : "Bonjour policy rule list",
            "items" : {
                "type" : "object",
                "description" : "Bonjour policy rule",
                "additionalProperties" : false,
                "properties" : {
                    "bridgeService" : {
                        "description" : "Bonjour Service Type",
                        "type" : "string",
                        "enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "GOOGLE_CHROMECAST", "OTHER" ]
                    },
                    "protocol" : {
                        "description" : "protocol. This is only available when bridgeService is OTHER",
                        "type" : "string",
                        "pattern" : "^(_[!-~]([ -~]){0,63}[!-~]\._tcp\.)|(_[!-~]([ -~]){0,63}[!-~]\._udp\.)$"
                    },
                    "fromVlan" : {
                        "description" : "From VLAN",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 4094
                    },
                    "toVlan" : {
                        "description" : "To VLAN",
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 4094
                    },
                    "notes" : {
                        "description" : "Notes",
                        "type" : "string",
                        "maximum" : 180
                    }
                },
                "required" : [ "bridgeService", "fromVlan", "toVlan" ]
            }
        }
    }
}
Response  204

Delete

DELETE/v11_1/rkszones/{zoneId}/bonjourGateway/policies/{id}

Use this API command to delete bonjour gateway policy.

Response  204

Bonjour Fencing Policy

Get Bonjour Fencing Statistic

GET/v11_1/aps/{apMac}/bonjourFencingStatistic

Use this API command to get Bonjour Fencing Statistic per AP.

Response  200
HideShow
Body
{
  "apMac": "33:22:11:22:66:44",
  "forwardedPackets": 30,
  "droppedPacketsDueToServiceType": 40,
  "droppedPacketsDueToNeighbor": 50,
  "serviceList": [
    {
      "serviceType": "AIRPLAY",
      "sourceType": "DIRECT"
    },
    {
      "serviceType": "AIRTUNES",
      "sourceType": "NEIGHBOR",
      "neighborApMac": "33:22:11:22:66:55",
      "neighborApName": "Ruckus AP"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apMac": {
      "type": "string"
    },
    "forwardedPackets": {
      "type": "integer"
    },
    "droppedPacketsDueToServiceType": {
      "type": "integer"
    },
    "droppedPacketsDueToNeighbor": {
      "type": "integer"
    },
    "serviceList": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "sourceType": {
            "type": "string",
            "enum": [
              "UNKNOWN",
              "DIRECT",
              "NEIGHBOR"
            ]
          },
          "neighborApMac": {
            "type": "string"
          },
          "neighborApName": {
            "type": "string"
          },
          "serviceType": {
            "description": "Bonjour Service Type",
            "type": "string",
            "enum": [
              "AIRDISK",
              "AIRPLAY",
              "AIRPORT_MANAGEMENT",
              "AIRPRINT",
              "AIRTUNES",
              "APPLE_FILE_SHARING",
              "APPLE_MOBILE_DEVICES",
              "APPLETV",
              "ICLOUD_SYNC",
              "ITUNES_REMOTE",
              "ITUNES_SHARING",
              "OPEN_DIRECTORY_MASTER",
              "OPTICAL_DISK_SHARING",
              "SCREEN_SHARING",
              "SECURE_FILE_SHARING",
              "SECURE_SHELL",
              "WWW_HTTP",
              "WWW_HTTPS",
              "WORKGROUP_MANAGER",
              "XGRID",
              "GOOGLE_CHROMECAST",
              "OTHER"
            ]
          }
        }
      }
    }
  }
}

Retrieve

GET/v11_1/rkszones/{zoneId}/bonjourFencingPolicy/{id}

Use this API command to retrieve Bonjour Fencing Policy.

Response  200
HideShow
Body
{
  "id": "1c942d00-4f36-11e6-8512-0a0027000000",
  "name": "bonjourPolicy",
  "description": "",
  "bonjourFencingRuleList": [
    {
      "deviceType": "Wired",
      "deviceMacList": [
        {
          "mac": "00:22:33:66:44:55"
        },
        {
          "mac": "00:22:33:66:44:66"
        }
      ],
      "closestAp": "33:22:11:22:66:55",
      "description": "desc",
      "serviceType": "AIRPLAY",
      "fencingRange": "SameAp"
    },
    {
      "deviceType": "Wireless",
      "serviceType": "OTHER",
      "customServiceName": "myService",
      "fencingRange": "SameAp"
    }
  ],
  "bonjourFencingRuleMappingList": [
    {
      "serviceType": "AIRPLAY",
      "customStringList": [
        "_caffe._tcp.",
        "_tea._udp."
      ]
    },
    {
      "serviceType": "OTHER",
      "customServiceName": "myService",
      "customStringList": [
        "_caffe1._tcp.",
        "_tea1._udp."
      ]
    }
  ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Bonjour Fencing Policy id",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the Bonjour Fencing Policy",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Bonjour Fencing Policy",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "zoneId" : {
            "description" : "Zone Id of The Bonjour Fencing Policy for clone in System Domain",
            "type" : "string"
        },
        "bonjourFencingRuleList" : {
            "description" : "Bonjour Fencing Rule List",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "deviceType" : {
                        "description" : "Name of the Bonjour Fencing Rule",
                        "type" : "string",
                        "enum" : [ "Wired", "Wireless" ]
                    },
                    "deviceMacList" : {
                        "description" : "Specify the device list providing Bonjour Service",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "mac" : {
                                    "description" : "Mac of the device providing Bonjour Service",
                                    "type" : "string",
                                    "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                                }
                            }
                        }
                    },
                    "closestAp" : {
                        "description" : "Specify the closest AP while device connecting to AP wired",
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                    },
                    "serviceType" : {
                        "description" : "Bonjour Service Type",
                        "type" : "string",
                        "enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "GOOGLE_CHROMECAST", "OTHER" ]
                    },
                    "customServiceName" : {
                        "description" : "The mapping name of Other type service",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                    },
                    "fencingRange" : {
                        "description" : "The range of AP can take Bonjour work",
                        "type" : "string",
                        "enum" : [ "SameAp", "OneHopAp" ]
                    },
                    "description" : {
                        "description" : "Description of the Bonjour Fencing Rule",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64
                    }
                },
                "required" : [ "deviceType", "serviceType", "fencingRange" ]
            }
        },
        "bonjourFencingRuleMappingList" : {
            "description" : "Bonjour Fencing Rule Mapping List",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "serviceType" : {
                        "description" : "Bonjour Service Type",
                        "type" : "string",
                        "enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "GOOGLE_CHROMECAST", "OTHER" ]
                    },
                    "customServiceName" : {
                        "description" : "The mapping name of Other type service",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                    },
                    "customStringList" : {
                        "description" : "The array of mdns string",
                        "type" : "array",
                        "items" : {
                            "description" : "The mdns string",
                            "type" : "string",
                            "pattern" : "^(_[!-~]([ -~]){0,63}[!-~]\._tcp\.)|(_[!-~]([ -~]){0,63}[!-~]\._udp\.)$"
                        }
                    }
                }
            }
        },
        "modifiedDateTime" : {
            "description" : "Timestamp of being modified",
            "type" : "integer",
            "format" : "int64"
        },
        "modifierUsername" : {
            "description" : "Modifier Name",
            "type" : "string"
        },
        "createDateTime" : {
            "description" : "Timestamp of being created",
            "type" : "integer"
        },
        "creatorId" : {
            "description" : "Creator ID",
            "type" : "string"
        },
        "modifierId" : {
            "description" : "Modifier ID",
            "type" : "string"
        },
        "creatorUsername" : {
            "description" : "Creator Name",
            "type" : "string"
        }
    },
    "required" : [ "name", "bonjourFencingRuleList" ]
}

Retrieve list

GET/v11_1/rkszones/{zoneId}/bonjourFencingPolicy

Use this API command to retrieve a list of Bonjour Fencing Policy.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "1c942d00-4f36-11e6-8512-0a0027000000",
      "name": "bonjourFencingPolicy",
      "description": "",
      "bonjourFencingRuleList": [
        {
          "deviceType": "Wired",
          "deviceMacList": [
            {
              "mac": "00:22:33:66:44:55"
            },
            {
              "mac": "00:22:33:66:44:66"
            }
          ],
          "closestAp": "33:22:11:22:66:55",
          "description": "desc",
          "serviceType": "AIRPLAY",
          "fencingRange": "SameAp"
        },
        {
          "deviceType": "Wireless",
          "serviceType": "OTHER",
          "customServiceName": "myService",
          "fencingRange": "SameAp"
        }
      ],
      "bonjourFencingRuleMappingList": [
        {
          "serviceType": "AIRPLAY",
          "customStringList": [
            "_caffe._tcp.",
            "_tea._udp."
          ]
        },
        {
          "serviceType": "OTHER",
          "customServiceName": "myService",
          "customStringList": [
            "_caffe1._tcp.",
            "_tea1._udp."
          ]
        }
      ]
    }
  ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "type" : "integer"
        },
        "hasMore" : {
            "type" : "boolean"
        },
        "firstIndex" : {
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Bonjour Fencing Policy id",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the Bonjour Fencing Policy",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                    },
                    "description" : {
                        "description" : "Description of the Bonjour Fencing Policy",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64
                    },
                    "zoneId" : {
                        "description" : "Zone Id of The Bonjour Fencing Policy for clone in System Domain",
                        "type" : "string"
                    },
                    "bonjourFencingRuleList" : {
                        "description" : "Bonjour Fencing Rule List",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "deviceType" : {
                                    "description" : "Name of the Bonjour Fencing Rule",
                                    "type" : "string",
                                    "enum" : [ "Wired", "Wireless" ]
                                },
                                "deviceMacList" : {
                                    "description" : "Specify the device list providing Bonjour Service",
                                    "type" : "array",
                                    "items" : {
                                        "type" : "object",
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "mac" : {
                                                "description" : "Mac of the device providing Bonjour Service",
                                                "type" : "string",
                                                "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                                            }
                                        }
                                    }
                                },
                                "closestAp" : {
                                    "description" : "Specify the closest AP while device connecting to AP wired",
                                    "type" : "string",
                                    "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                                },
                                "serviceType" : {
                                    "description" : "Bonjour Service Type",
                                    "type" : "string",
                                    "enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "GOOGLE_CHROMECAST", "OTHER" ]
                                },
                                "customServiceName" : {
                                    "description" : "The mapping name of Other type service",
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32,
                                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                                },
                                "fencingRange" : {
                                    "description" : "The range of AP can take Bonjour work",
                                    "type" : "string",
                                    "enum" : [ "SameAp", "OneHopAp" ]
                                },
                                "description" : {
                                    "description" : "Description of the Bonjour Fencing Rule",
                                    "type" : [ "string", "null" ],
                                    "maxLength" : 64
                                }
                            },
                            "required" : [ "deviceType", "serviceType", "fencingRange" ]
                        }
                    },
                    "bonjourFencingRuleMappingList" : {
                        "description" : "Bonjour Fencing Rule Mapping List",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "serviceType" : {
                                    "description" : "Bonjour Service Type",
                                    "type" : "string",
                                    "enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "GOOGLE_CHROMECAST", "OTHER" ]
                                },
                                "customServiceName" : {
                                    "description" : "The mapping name of Other type service",
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32,
                                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                                },
                                "customStringList" : {
                                    "description" : "The array of mdns string",
                                    "type" : "array",
                                    "items" : {
                                        "description" : "The mdns string",
                                        "type" : "string",
                                        "pattern" : "^(_[!-~]([ -~]){0,63}[!-~]\._tcp\.)|(_[!-~]([ -~]){0,63}[!-~]\._udp\.)$"
                                    }
                                }
                            }
                        }
                    },
                    "modifiedDateTime" : {
                        "description" : "Timestamp of being modified",
                        "type" : "integer",
                        "format" : "int64"
                    },
                    "modifierUsername" : {
                        "description" : "Modifier Name",
                        "type" : "string"
                    },
                    "createDateTime" : {
                        "description" : "Timestamp of being created",
                        "type" : "integer"
                    },
                    "creatorId" : {
                        "description" : "Creator ID",
                        "type" : "string"
                    },
                    "modifierId" : {
                        "description" : "Modifier ID",
                        "type" : "string"
                    },
                    "creatorUsername" : {
                        "description" : "Creator Name",
                        "type" : "string"
                    }
                },
                "required" : [ "name", "bonjourFencingRuleList" ]
            }
        }
    }
}

Retrieve list

POST/v11_1/query/services/bonjourFencingPolicy

Use this API command to retrieve a list of Bonjour Fencing Policy. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "1c942d00-4f36-11e6-8512-0a0027000000",
      "name": "bonjourFencingPolicy",
      "description": "",
      "bonjourFencingRuleList": [
        {
          "deviceType": "Wired",
          "deviceMacList": [
            {
              "mac": "00:22:33:66:44:55"
            },
            {
              "mac": "00:22:33:66:44:66"
            }
          ],
          "closestAp": "33:22:11:22:66:55",
          "description": "desc",
          "serviceType": "AIRPLAY",
          "fencingRange": "SameAp"
        },
        {
          "deviceType": "Wireless",
          "serviceType": "OTHER",
          "customServiceName": "myService",
          "fencingRange": "SameAp"
        }
      ],
      "bonjourFencingRuleMappingList": [
        {
          "serviceType": "AIRPLAY",
          "customStringList": [
            "_caffe._tcp.",
            "_tea._udp."
          ]
        },
        {
          "serviceType": "OTHER",
          "customServiceName": "myService",
          "customStringList": [
            "_caffe1._tcp.",
            "_tea1._udp."
          ]
        }
      ]
    }
  ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "type" : "integer"
        },
        "hasMore" : {
            "type" : "boolean"
        },
        "firstIndex" : {
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Bonjour Fencing Policy id",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the Bonjour Fencing Policy",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                    },
                    "description" : {
                        "description" : "Description of the Bonjour Fencing Policy",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64
                    },
                    "zoneId" : {
                        "description" : "Zone Id of The Bonjour Fencing Policy for clone in System Domain",
                        "type" : "string"
                    },
                    "bonjourFencingRuleList" : {
                        "description" : "Bonjour Fencing Rule List",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "deviceType" : {
                                    "description" : "Name of the Bonjour Fencing Rule",
                                    "type" : "string",
                                    "enum" : [ "Wired", "Wireless" ]
                                },
                                "deviceMacList" : {
                                    "description" : "Specify the device list providing Bonjour Service",
                                    "type" : "array",
                                    "items" : {
                                        "type" : "object",
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "mac" : {
                                                "description" : "Mac of the device providing Bonjour Service",
                                                "type" : "string",
                                                "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                                            }
                                        }
                                    }
                                },
                                "closestAp" : {
                                    "description" : "Specify the closest AP while device connecting to AP wired",
                                    "type" : "string",
                                    "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                                },
                                "serviceType" : {
                                    "description" : "Bonjour Service Type",
                                    "type" : "string",
                                    "enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "GOOGLE_CHROMECAST", "OTHER" ]
                                },
                                "customServiceName" : {
                                    "description" : "The mapping name of Other type service",
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32,
                                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                                },
                                "fencingRange" : {
                                    "description" : "The range of AP can take Bonjour work",
                                    "type" : "string",
                                    "enum" : [ "SameAp", "OneHopAp" ]
                                },
                                "description" : {
                                    "description" : "Description of the Bonjour Fencing Rule",
                                    "type" : [ "string", "null" ],
                                    "maxLength" : 64
                                }
                            },
                            "required" : [ "deviceType", "serviceType", "fencingRange" ]
                        }
                    },
                    "bonjourFencingRuleMappingList" : {
                        "description" : "Bonjour Fencing Rule Mapping List",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "serviceType" : {
                                    "description" : "Bonjour Service Type",
                                    "type" : "string",
                                    "enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "GOOGLE_CHROMECAST", "OTHER" ]
                                },
                                "customServiceName" : {
                                    "description" : "The mapping name of Other type service",
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32,
                                    "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                                },
                                "customStringList" : {
                                    "description" : "The array of mdns string",
                                    "type" : "array",
                                    "items" : {
                                        "description" : "The mdns string",
                                        "type" : "string",
                                        "pattern" : "^(_[!-~]([ -~]){0,63}[!-~]\._tcp\.)|(_[!-~]([ -~]){0,63}[!-~]\._udp\.)$"
                                    }
                                }
                            }
                        }
                    },
                    "modifiedDateTime" : {
                        "description" : "Timestamp of being modified",
                        "type" : "integer",
                        "format" : "int64"
                    },
                    "modifierUsername" : {
                        "description" : "Modifier Name",
                        "type" : "string"
                    },
                    "createDateTime" : {
                        "description" : "Timestamp of being created",
                        "type" : "integer"
                    },
                    "creatorId" : {
                        "description" : "Creator ID",
                        "type" : "string"
                    },
                    "modifierId" : {
                        "description" : "Modifier ID",
                        "type" : "string"
                    },
                    "creatorUsername" : {
                        "description" : "Creator Name",
                        "type" : "string"
                    }
                },
                "required" : [ "name", "bonjourFencingRuleList" ]
            }
        }
    }
}

Create

POST/v11_1/rkszones/{zoneId}/bonjourFencingPolicy

Use this API command to create Bonjour Fencing Policy.

Request
HideShow
Body
{
  "name": "bonjourPolicy",
  "description": "",
  "bonjourFencingRuleList": [
    {
      "deviceType": "Wired",
      "deviceMacList": [
        {
          "mac": "00:22:33:66:44:55"
        },
        {
          "mac": "00:22:33:66:44:66"
        }
      ],
      "closestAp": "33:22:11:22:66:55",
      "description": "desc",
      "serviceType": "AIRPLAY",
      "fencingRange": "SameAp"
    },
    {
      "deviceType": "Wireless",
      "serviceType": "OTHER",
      "customServiceName": "myService",
      "fencingRange": "SameAp"
    }
  ],
  "bonjourFencingRuleMappingList": [
    {
      "serviceType": "AIRPLAY",
      "customStringList": [
        "_caffe._tcp.",
        "_tea._udp."
      ]
    },
    {
      "serviceType": "OTHER",
      "customServiceName": "myService",
      "customStringList": [
        "_caffe1._tcp.",
        "_tea1._udp."
      ]
    }
  ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the Bonjour Fencing Policy",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Bonjour Fencing Policy",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bonjourFencingRuleList" : {
            "description" : "Bonjour Fencing Rule List",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "deviceType" : {
                        "description" : "Name of the Bonjour Fencing Rule",
                        "type" : "string",
                        "enum" : [ "Wired", "Wireless" ]
                    },
                    "deviceMacList" : {
                        "description" : "Specify the device list providing Bonjour Service",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "mac" : {
                                    "description" : "Mac of the device providing Bonjour Service",
                                    "type" : "string",
                                    "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                                }
                            }
                        }
                    },
                    "closestAp" : {
                        "description" : "Specify the closest AP while device connecting to AP wired",
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                    },
                    "serviceType" : {
                        "description" : "Bonjour Service Type",
                        "type" : "string",
                        "enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "GOOGLE_CHROMECAST", "OTHER" ]
                    },
                    "customServiceName" : {
                        "description" : "The mapping name of Other type service",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                    },
                    "fencingRange" : {
                        "description" : "The range of AP can take Bonjour work",
                        "type" : "string",
                        "enum" : [ "SameAp", "OneHopAp" ]
                    },
                    "description" : {
                        "description" : "Description of the Bonjour Fencing Rule",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64
                    }
                },
                "required" : [ "deviceType", "serviceType", "fencingRange" ]
            }
        },
        "bonjourFencingRuleMappingList" : {
            "description" : "Bonjour Fencing Rule Mapping List",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "serviceType" : {
                        "description" : "Bonjour Service Type",
                        "type" : "string",
                        "enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "GOOGLE_CHROMECAST", "OTHER" ]
                    },
                    "customServiceName" : {
                        "description" : "The mapping name of Other type service",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                    },
                    "customStringList" : {
                        "description" : "The array of mdns string",
                        "type" : "array",
                        "items" : {
                            "description" : "The mdns string",
                            "type" : "string",
                            "pattern" : "^(_[!-~]([ -~]){0,63}[!-~]\._tcp\.)|(_[!-~]([ -~]){0,63}[!-~]\._udp\.)$"
                        }
                    }
                }
            }
        }
    },
    "required" : [ "name", "bonjourFencingRuleList" ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v11_1/rkszones/{zoneId}/bonjourFencingPolicy/{id}

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

Request
HideShow
Body
{
  "name": "bonjourPolicy123",
  "description": "this is desc",
  "bonjourFencingRuleList": [
    {
      "deviceType": "Wireless",
      "description": "desc",
      "serviceType": "AIRPLAY",
      "fencingRange": "SameAp"
    },
    {
      "deviceType": "Wireless",
      "serviceType": "OTHER",
      "customServiceName": "myService",
      "fencingRange": "SameAp"
    }
  ],
  "bonjourFencingRuleMappingList": [
    {
      "serviceType": "AIRPLAY",
      "customStringList": [
        "_caffe._tcp.",
        "_tea._udp."
      ]
    },
    {
      "serviceType": "OTHER",
      "customServiceName": "myService",
      "customStringList": [
        "_caffe1._tcp.",
        "_tea1._udp."
      ]
    }
  ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the Bonjour Fencing Rule",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Bonjour Fencing Rule",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bonjourFencingRuleList" : {
            "description" : "Bonjour Fencing Rule List",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "deviceType" : {
                        "description" : "Name of the Bonjour Fencing Rule",
                        "type" : "string",
                        "enum" : [ "Wired", "Wireless" ]
                    },
                    "deviceMacList" : {
                        "description" : "Specify the device list providing Bonjour Service",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "mac" : {
                                    "description" : "Mac of the device providing Bonjour Service",
                                    "type" : "string",
                                    "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                                }
                            }
                        }
                    },
                    "closestAp" : {
                        "description" : "Specify the closest AP while device connecting to AP wired",
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                    },
                    "serviceType" : {
                        "description" : "Bonjour Service Type",
                        "type" : "string",
                        "enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "GOOGLE_CHROMECAST", "OTHER" ]
                    },
                    "customServiceName" : {
                        "description" : "The mapping name of Other type service",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                    },
                    "fencingRange" : {
                        "description" : "The range of AP can take Bonjour work",
                        "type" : "string",
                        "enum" : [ "SameAp", "OneHopAp" ]
                    },
                    "description" : {
                        "description" : "Description of the Bonjour Fencing Rule",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64
                    }
                },
                "required" : [ "deviceType", "serviceType", "fencingRange" ]
            }
        },
        "bonjourFencingRuleMappingList" : {
            "description" : "Bonjour Fencing Rule Mapping List",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "serviceType" : {
                        "description" : "Bonjour Service Type",
                        "type" : "string",
                        "enum" : [ "AIRDISK", "AIRPLAY", "AIRPORT_MANAGEMENT", "AIRPRINT", "AIRTUNES", "APPLE_FILE_SHARING", "APPLE_MOBILE_DEVICES", "APPLETV", "ICLOUD_SYNC", "ITUNES_REMOTE", "ITUNES_SHARING", "OPEN_DIRECTORY_MASTER", "OPTICAL_DISK_SHARING", "SCREEN_SHARING", "SECURE_FILE_SHARING", "SECURE_SHELL", "WWW_HTTP", "WWW_HTTPS", "WORKGROUP_MANAGER", "XGRID", "GOOGLE_CHROMECAST", "OTHER" ]
                    },
                    "customServiceName" : {
                        "description" : "The mapping name of Other type service",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                    },
                    "customStringList" : {
                        "description" : "The array of mdns string",
                        "type" : "array",
                        "items" : {
                            "description" : "The mdns string",
                            "type" : "string",
                            "pattern" : "^(_[!-~]([ -~]){0,63}[!-~]\._tcp\.)|(_[!-~]([ -~]){0,63}[!-~]\._udp\.)$"
                        }
                    }
                }
            }
        }
    }
}
Response  204

Delete

DELETE/v11_1/rkszones/bonjourFencingPolicy/{id}

Use this API command to delete Bonjour Fencing Policy.

Response  204

Delete

DELETE/v11_1/rkszones/bonjourFencingPolicy

Use this API command to delete Bulk Bonjour Fencing Policy.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Client Isolation Whitelist

Retrieve

GET/v11_1/rkszones/{zoneId}/clientIsolationWhitelist/{id}

Retrieve an Client Isolation Whitelist.

Response  200
HideShow
Body
{
  "id": "1c942d00-4f36-11e6-8512-0a0027000000",
  "name": "clientIsolationWhitelist_1",
  "description": "",
  "whitelist": [
    {
      "mac": "00:22:33:66:44:55",
      "ip": "10.2.3.111",
      "description": "desc"
    },
    {
      "mac": "00:22:33:66:44:66",
      "ip": "10.2.3.123",
      "description": "desc2"
    }
  ],
  "clientIsolationAutoEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Client Isolation Whitelist id",
      "type": "string"
    },
    "name": {
      "description": "Client Isolation Whitelist name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Client Isolation Whitelist description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "zoneId": {
      "description": "Zone Id of The Bonjour Fencing Policy for clone in System Domain",
      "type": "string"
    },
    "whitelist": {
      "description": "Client Isolation Whitelist array",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "mac": {
            "description": "Client Entry Mac",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "ip": {
            "description": "Client Entry ip",
            "type": [
              "string",
              "null"
            ]
          },
          "description": {
            "description": "Client Entry description",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          }
        },
        "required": [
          "mac"
        ]
      }
    },
    "clientIsolationAutoEnabled": {
      "description": "Client Isolation Auto Enable",
      "type": "boolean"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer",
      "format": "int64"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    }
  },
  "required": [
    "name",
    "whitelist",
    "clientIsolationAutoEnabled"
  ]
}

Retrieve List

GET/v11_1/rkszones/{zoneId}/clientIsolationWhitelist

Retrieve a list of Client Isolation Whitelist.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "1c942d00-4f36-11e6-8512-0a0027000000",
      "name": "clientIsolationWhitelist_1",
      "description": "",
      "whitelist": [
        {
          "mac": "00:22:33:66:44:55",
          "ip": "10.2.3.111",
          "description": "desc"
        },
        {
          "mac": "00:22:33:66:44:66",
          "ip": "10.2.3.123",
          "description": "desc2"
        }
      ],
      "clientIsolationAutoEnabled": true
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Client Isolation Whitelist id",
            "type": "string"
          },
          "name": {
            "description": "Client Isolation Whitelist name",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Client Isolation Whitelist description",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "zoneId": {
            "description": "Zone Id of The Bonjour Fencing Policy for clone in System Domain",
            "type": "string"
          },
          "whitelist": {
            "description": "Client Isolation Whitelist array",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "mac": {
                  "description": "Client Entry Mac",
                  "type": "string",
                  "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                },
                "ip": {
                  "description": "Client Entry ip",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "description": {
                  "description": "Client Entry description",
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 64
                }
              },
              "required": [
                "mac"
              ]
            }
          },
          "clientIsolationAutoEnabled": {
            "description": "Client Isolation Auto Enable",
            "type": "boolean"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer",
            "format": "int64"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          }
        },
        "required": [
          "name",
          "whitelist",
          "clientIsolationAutoEnabled"
        ]
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Retrieve List

POST/v11_1/query/services/clientIsolationWhitelist

Retrieve a list of Client Isolation Whitelist. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "1c942d00-4f36-11e6-8512-0a0027000000",
      "name": "clientIsolationWhitelist_1",
      "description": "",
      "whitelist": [
        {
          "mac": "00:22:33:66:44:55",
          "ip": "10.2.3.111",
          "description": "desc"
        },
        {
          "mac": "00:22:33:66:44:66",
          "ip": "10.2.3.123",
          "description": "desc2"
        }
      ],
      "clientIsolationAutoEnabled": true
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Client Isolation Whitelist id",
            "type": "string"
          },
          "name": {
            "description": "Client Isolation Whitelist name",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Client Isolation Whitelist description",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "zoneId": {
            "description": "Zone Id of The Bonjour Fencing Policy for clone in System Domain",
            "type": "string"
          },
          "whitelist": {
            "description": "Client Isolation Whitelist array",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "mac": {
                  "description": "Client Entry Mac",
                  "type": "string",
                  "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                },
                "ip": {
                  "description": "Client Entry ip",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "description": {
                  "description": "Client Entry description",
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 64
                }
              },
              "required": [
                "mac"
              ]
            }
          },
          "clientIsolationAutoEnabled": {
            "description": "Client Isolation Auto Enable",
            "type": "boolean"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer",
            "format": "int64"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          }
        },
        "required": [
          "name",
          "whitelist",
          "clientIsolationAutoEnabled"
        ]
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Create Client Isolation Whitelist

POST/v11_1/rkszones/{zoneId}/clientIsolationWhitelist

Create a new ClientIsolationWhitelist.

Request
HideShow
Body
{
  "name": "clientIsolationWhitelist_1",
  "description": "",
  "whitelist": [
    {
      "mac": "00:22:33:66:44:55",
      "ip": "10.2.3.111",
      "description": "desc"
    },
    {
      "mac": "00:22:33:66:44:66",
      "ip": "10.2.3.123",
      "description": "desc2"
    }
  ],
  "clientIsolationAutoEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Client Isolation Whitelist name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Client Isolation Whitelist description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "whitelist": {
      "description": "Client Isolation Whitelist array",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "mac": {
            "description": "Client Entry Mac",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "ip": {
            "description": "Client Entry ip",
            "type": [
              "string",
              "null"
            ]
          },
          "description": {
            "description": "Client Entry description",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          }
        },
        "required": [
          "mac"
        ]
      }
    },
    "clientIsolationAutoEnabled": {
      "description": "Client Isolation Auto Enable",
      "type": "boolean"
    }
  },
  "required": [
    "name",
    "whitelist",
    "clientIsolationAutoEnabled"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v11_1/rkszones/{zoneId}/clientIsolationWhitelist/{id}

Modify a specific Client Isolation Whitelist basic.

Request
HideShow
Body
{
  "name": "clientIsolationWhitelist_1",
  "description": "this is desc",
  "whitelist": [
    {
      "mac": "AA:22:33:66:44:55",
      "ip": "10.2.3.111",
      "description": "desc"
    },
    {
      "mac": "AA:22:33:66:44:66",
      "ip": "10.2.3.99",
      "description": "desc2"
    }
  ],
  "clientIsolationAutoEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Client Isolation Whitelist name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Client Isolation Whitelist description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "whitelist": {
      "description": "Client Isolation Whitelist array",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "mac": {
            "description": "Client Entry Mac",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "ip": {
            "description": "Client Entry ip",
            "type": [
              "string",
              "null"
            ]
          },
          "description": {
            "description": "Client Entry description",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          }
        },
        "required": [
          "mac"
        ]
      }
    },
    "clientIsolationAutoEnabled": {
      "description": "Client Isolation Auto Enable",
      "type": "boolean"
    }
  }
}
Response  204

Delete

DELETE/v11_1/rkszones/clientIsolationWhitelist/{id}

Delete a Client Isolation Whitelist.

Response  204

Delete

DELETE/v11_1/rkszones/clientIsolationWhitelist

Use this API command to delete Bulk Client Isolation Whitelist.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Restricted AP Access Profile

Retrieve

GET/v11_1/rkszones/{zoneId}/restrictedApAccessProfiles

Retrieve Restricted AP Access Profile list.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": [
          "object",
          "null"
        ],
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve

GET/v11_1/rkszones/{zoneId}/restrictedApAccessProfiles/{id}

Retrieve a Restricted AP Access Profile.

Response  200
HideShow
Body
{
  "id": "839f87c6-d116-497e-afce-aa8157abdasd",
  "name": "RAA profile1",
  "description": "RAA description",
  "blockedPortList": [
    {
      "protocol": "BOTH",
      "port": 1999
    },
    {
      "protocol": "TCP",
      "port": 1000
    }
  ],
  "ipAddressWhitelist": [
    "192.168.5.5",
    "10.206.10.20/24"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Restricted AP Access Profile id",
      "type": "string"
    },
    "name": {
      "description": "Name of the Restricted AP Access Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "zoneId": {
      "description": "Zone Id of The Restricted AP Access Profile for clone in System Domain",
      "type": "string"
    },
    "description": {
      "description": "Description of the Restricted AP Access Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "blockedPortList": {
      "description": "Blocked Port List",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "protocol": {
            "type": "string",
            "enum": [
              "BOTH",
              "TCP",
              "UDP"
            ],
            "description": "Protocol of the Blocked Port"
          },
          "port": {
            "type": "string",
            "description": "port of the Blocked Port"
          }
        }
      }
    },
    "ipAddressWhitelist": {
      "description": "IP Address Whitelist",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer",
      "format": "int64"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer",
      "format": "int64"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "blockWellKnownPort": {
      "description": "Block well known ports",
      "type": "boolean"
    }
  },
  "required": [
    "name"
  ]
}

Retrieve

POST/v11_1/rkszones/restrictedApAccessProfiles/query

Retrieve a list of Restricted AP Access Profile. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "list": [
    {
      "id": "839f87c6-d116-497e-afce-aa8157abdasd",
      "name": "RAA profile1",
      "description": "RAA description",
      "blockedPortList": [
        {
          "protocol": "BOTH",
          "port": 1999
        },
        {
          "protocol": "TCP",
          "port": 1099
        }
      ],
      "ipAddressWhitelist": [
        "192.168.5.5",
        "10.206.10.20/24"
      ]
    },
    {
      "id": "839f87c6-d116-497e-afce-aa8157ab1111",
      "name": "RAA profile1",
      "description": "RAA description",
      "blockedPortList": [
        {
          "protocol": "BOTH",
          "port": 1999
        },
        {
          "protocol": "UDP",
          "port": 1099
        }
      ],
      "ipAddressWhitelist": [
        "fe80::1",
        "fe80::20/120"
      ]
    }
  ]
}
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": "Restricted AP Access Profile id",
            "type": "string"
          },
          "name": {
            "description": "Name of the Restricted AP Access Profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "zoneId": {
            "description": "Zone Id of The Restricted AP Access Profile for clone in System Domain",
            "type": "string"
          },
          "description": {
            "description": "Description of the Restricted AP Access Profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "blockedPortList": {
            "description": "Blocked Port List",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "protocol": {
                  "type": "string",
                  "enum": [
                    "BOTH",
                    "TCP",
                    "UDP"
                  ],
                  "description": "Protocol of the Blocked Port"
                },
                "port": {
                  "type": "string",
                  "description": "port of the Blocked Port"
                }
              }
            }
          },
          "ipAddressWhitelist": {
            "description": "IP Address Whitelist",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer",
            "format": "int64"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer",
            "format": "int64"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "blockWellKnownPort": {
            "description": "Block well known ports",
            "type": "boolean"
          }
        },
        "required": [
          "name"
        ]
      }
    }
  }
}

Create

POST/v11_1/rkszones/{zoneId}/restrictedApAccessProfiles

Create a Restricted AP Access Profile.

Request
HideShow
Body
{
  "name": "RAA profile1",
  "description": "RAA description",
  "blockedPortList": [
    {
      "protocol": "BOTH",
      "port": 1999
    },
    {
      "protocol": "TCP",
      "port": 1000
    }
  ],
  "ipAddressWhitelist": [
    "192.168.5.5",
    "10.206.10.20/24"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Restricted AP Access Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Restricted AP Access Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "blockedPortList": {
      "description": "Blocked Port List",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "protocol": {
            "type": "string",
            "enum": [
              "BOTH",
              "TCP",
              "UDP"
            ],
            "description": "Protocol of the Blocked Port"
          },
          "port": {
            "type": "string",
            "description": "port of the Blocked Port"
          }
        }
      }
    },
    "ipAddressWhitelist": {
      "description": "IP Address Whitelist",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "blockWellKnownPort": {
      "description": "Block well known ports",
      "type": "boolean",
      "default": false
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PUT/v11_1/rkszones/{zoneId}/restrictedApAccessProfiles/{id}

Modify a Restricted AP Access Profile.

Request
HideShow
Body
{
  "name": "RAA profile1",
  "description": "RAA description",
  "blockedPortList": [
    {
      "protocol": "BOTH",
      "port": 1999
    },
    {
      "protocol": "TCP",
      "port": 1099
    }
  ],
  "ipAddressWhitelist": [
    "192.168.5.5",
    "10.206.10.20/24"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Restricted AP Access Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Restricted AP Access Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "blockedPortList": {
      "description": "Blocked Port List",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "protocol": {
            "type": "string",
            "enum": [
              "BOTH",
              "TCP",
              "UDP"
            ],
            "description": "Protocol of the Blocked Port"
          },
          "port": {
            "type": "string",
            "description": "port of the Blocked Port"
          }
        }
      }
    },
    "ipAddressWhitelist": {
      "description": "IP Address Whitelist",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "blockWellKnownPort": {
      "description": "Block well known ports",
      "type": "boolean"
    }
  },
  "required": [
    "name"
  ]
}
Response  204

Delete

DELETE/v11_1/rkszones/{zoneId}/restrictedApAccessProfiles/{id}

Delete a Restricted AP Access Profile.

Response  204

Delete

DELETE/v11_1/rkszones/restrictedApAccessProfiles

Use this API command to delete Bulk Restricted AP Access Profile.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Authentication Service

Retrieve - LocalDB Authentication Service

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

Use this API command to retrieve a LocalDB authentication service.

Response  200
HideShow
Body
{
  "id": "accountingServiceUUID",
  "mvnoId": "userMVNOId",
  "domainId": "userDomainId",
  "name": "accountingServiceName",
  "description": "accountingServiceDescription",
  "protocol": "RADIUS"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the authentication service",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "description": "Name of the authentication service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "friendlyName": {
      "description": "Friendly name of the authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "description": {
      "description": "Description of the authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "protocol": {
      "description": "Authentication protocol.",
      "type": "string",
      "enum": [
        "RADIUS",
        "AD",
        "LDAP",
        "FACEBOOK",
        "LINKEDIN",
        "GOOGLE",
        "GENERICOAUTH",
        "SOAP",
        "HLR",
        "LOCAL_DB",
        "GUEST"
      ]
    },
    "type": {
      "description": "Authentication protocol same as protocol.",
      "type": "string",
      "enum": [
        "RADIUS",
        "AD",
        "LDAP",
        "FACEBOOK",
        "LINKEDIN",
        "GOOGLE",
        "GENERICOAUTH",
        "SOAP",
        "HLR",
        "LOCAL_DB",
        "GUEST"
      ]
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "id": {
            "type": "string",
            "description": "Group attribute mapping UUID"
          },
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              },
              "userTrafficProfile": {
                "type": "object",
                "description": "Identity user role",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "User traffic profile UUID"
                  },
                  "name": {
                    "type": "string",
                    "description": "User traffic profile name"
                  }
                }
              },
              "firewallProfileId": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "tlsEnabled": {
      "type": "boolean"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Retrieve - Guest Authentication Service

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

Use this API command to retrieve a Guest authentication service.

Response  200
HideShow
Body
{
  "id": "accountingServiceUUID",
  "mvnoId": "userMVNOId",
  "domainId": "userDomainId",
  "name": "accountingServiceName",
  "description": "accountingServiceDescription",
  "protocol": "RADIUS"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the authentication service",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "description": "Name of the authentication service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "friendlyName": {
      "description": "Friendly name of the authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "description": {
      "description": "Description of the authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "protocol": {
      "description": "Authentication protocol.",
      "type": "string",
      "enum": [
        "RADIUS",
        "AD",
        "LDAP",
        "FACEBOOK",
        "LINKEDIN",
        "GOOGLE",
        "GENERICOAUTH",
        "SOAP",
        "HLR",
        "LOCAL_DB",
        "GUEST"
      ]
    },
    "type": {
      "description": "Authentication protocol same as protocol.",
      "type": "string",
      "enum": [
        "RADIUS",
        "AD",
        "LDAP",
        "FACEBOOK",
        "LINKEDIN",
        "GOOGLE",
        "GENERICOAUTH",
        "SOAP",
        "HLR",
        "LOCAL_DB",
        "GUEST"
      ]
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "id": {
            "type": "string",
            "description": "Group attribute mapping UUID"
          },
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              },
              "userTrafficProfile": {
                "type": "object",
                "description": "Identity user role",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "User traffic profile UUID"
                  },
                  "name": {
                    "type": "string",
                    "description": "User traffic profile name"
                  }
                }
              },
              "firewallProfileId": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "tlsEnabled": {
      "type": "boolean"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Retrieve List - RADIUS Authentication Service

GET/v11_1/services/auth/radius

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

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

Retrieve - RADIUS Authentication Service

GET/v11_1/services/auth/radius/{id}

Use this API command to retrieve a RADIUS authentication service.

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

Retrieve List - Active Directory Authentication Service

GET/v11_1/services/auth/ad

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

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "49322250-6afd-11e4-832a-dc6020524153",
      "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "userDomainId",
      "protocol": "AD",
      "name": "rapheal-ad",
      "friendlyName": "",
      "description": "",
      "mappings": [
        {
          "id": "c7608860-6afd-11e4-b9bb-08002716c79f",
          "groupAttr": "*",
          "userRole": {
            "id": "636431d6-c06e-4692-a28f-3914afc2a817",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "fbde8510-6972-11e4-926e-08002716c79f",
              "name": "System Default"
            }
          }
        }
      ],
      "ip": "1.1.1.1",
      "port": 3268,
      "windowsDomainName": "dc=domain",
      "adminDomainName": "[email protected]",
      "password": "abced",
      "globalCatalogEnabled": true
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for AD authentication service",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the active directory authentication service",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "protocol": {
            "description": "Authentication protocol.",
            "type": "string",
            "enum": [
              "AD"
            ]
          },
          "type": {
            "description": "Authentication protocol.",
            "type": "string",
            "enum": [
              "AD"
            ]
          },
          "name": {
            "description": "Name of the active directory authentication service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "friendlyName": {
            "description": "Friendly name of the active directory authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
          },
          "description": {
            "description": "Description of the active directory authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "ip": {
            "description": "IP address",
            "type": "string"
          },
          "port": {
            "description": "Port",
            "type": "integer",
            "minimum": 1,
            "maximum": 65535,
            "default": 389
          },
          "windowsDomainName": {
            "description": "Windows domain name",
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
          },
          "adminDomainName": {
            "description": "Admin domain name",
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
          },
          "password": {
            "description": "Admin password",
            "type": "string"
          },
          "tlsEnabled": {
            "description": "AD over TLS Enabled",
            "type": "boolean"
          },
          "cnIdentity": {
            "maxLength": 64,
            "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": {
                      "description": "Identity user role name",
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 64,
                      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
                    },
                    "userTrafficProfile": {
                      "type": "object",
                      "description": "Identity user role",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "User traffic profile UUID"
                        },
                        "name": {
                          "type": "string",
                          "description": "User traffic profile name"
                        }
                      }
                    },
                    "firewallProfileId": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "groupAttr",
                "userRole"
              ]
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve - Active Directory Authentication Service

GET/v11_1/services/auth/ad/{id}

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

Response  200
HideShow
Body
{
  "id": "49322250-6afd-11e4-832a-dc6020524153",
  "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "domainId": "userDomainId",
  "protocol": "AD",
  "name": "rapheal-ad",
  "friendlyName": "",
  "description": "",
  "mappings": [
    {
      "id": "c7608860-6afd-11e4-b9bb-08002716c79f",
      "groupAttr": "*",
      "userRole": {
        "id": "636431d6-c06e-4692-a28f-3914afc2a817",
        "name": "identity user role name",
        "userTrafficProfile": {
          "id": "fbde8510-6972-11e4-926e-08002716c79f",
          "name": "System Default"
        }
      }
    }
  ],
  "ip": "1.1.1.1",
  "port": 3268,
  "windowsDomainName": "dc=domain",
  "adminDomainName": "[email protected]",
  "password": "abced",
  "tlsEnabled": false,
  "globalCatalogEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the active directory authentication service",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "protocol": {
      "description": "Authentication protocol.",
      "type": "string",
      "enum": [
        "AD"
      ]
    },
    "type": {
      "description": "Authentication protocol.",
      "type": "string",
      "enum": [
        "AD"
      ]
    },
    "name": {
      "description": "Name of the active directory authentication service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "friendlyName": {
      "description": "Friendly name of the active directory authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "description": {
      "description": "Description of the active directory authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535,
      "default": 389
    },
    "windowsDomainName": {
      "description": "Windows domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "tlsEnabled": {
      "description": "AD over TLS Enabled",
      "type": "boolean"
    },
    "cnIdentity": {
      "maxLength": 64,
      "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": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              },
              "userTrafficProfile": {
                "type": "object",
                "description": "Identity user role",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "User traffic profile UUID"
                  },
                  "name": {
                    "type": "string",
                    "description": "User traffic profile name"
                  }
                }
              },
              "firewallProfileId": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Retrieve List - LDAP Authentication Service

GET/v11_1/services/auth/ldap

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

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "18b76a50-6a57-11e4-96af-dc6020524153",
      "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
      "protocol": "LDAP",
      "name": "rapheal-ldap",
      "friendlyName": "",
      "description": "",
      "mappings": [
        {
          "id": "afa788e0-6afd-11e4-b9bb-08002716c79f",
          "groupAttr": "*",
          "userRole": {
            "id": "636431d6-c06e-4692-a28f-3914afc2a817",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "fbde8510-6972-11e4-926e-08002716c79f",
              "name": "System Default"
            }
          }
        },
        {
          "id": "afaa4800-6afd-11e4-b9bb-08002716c79f",
          "groupAttr": "abcd",
          "userRole": {
            "id": "636431d6-c06e-4692-a28f-3914afc2a817",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "fbde8510-6972-11e4-926e-08002716c79f",
              "name": "System Default"
            }
          }
        }
      ],
      "tlsEnabled": true,
      "clientCertId": "1dde2460-c624-11e8-88b3-000000441962",
      "ip": "1.1.1.122",
      "port": 389,
      "baseDomainName": "dc=ldap",
      "adminDomainName": "uid=ibm",
      "password": "admin",
      "keyAttribute": "uid",
      "searchFilter": "(objectClass=*)"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for ldap authentication service",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the LDAP authentication service",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "name": {
            "description": "Name of the LDAP authentication service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "friendlyName": {
            "description": "Friendly name of the LDAP authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
          },
          "protocol": {
            "description": "Authentication protocol",
            "type": "string",
            "enum": [
              "LDAP"
            ]
          },
          "type": {
            "description": "Authentication protocol same as protocol.",
            "type": "string",
            "enum": [
              "LDAP"
            ]
          },
          "description": {
            "description": "Description of the LDAP authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "tlsEnabled": {
            "description": "LDAP over TLS Enabled",
            "type": "boolean"
          },
          "cnIdentity": {
            "maxLength": 64,
            "type": "string"
          },
          "ip": {
            "description": "IP address",
            "type": "string"
          },
          "port": {
            "description": "Port",
            "type": "integer"
          },
          "baseDomainName": {
            "description": "Base domain name",
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
          },
          "adminDomainName": {
            "description": "Admin domain name",
            "type": "string",
            "minLength": 2,
            "maxLength": 128,
            "pattern": "^[!-~]([ -~]){0,126}[!-~]$"
          },
          "password": {
            "description": "Admin password",
            "type": "string"
          },
          "keyAttribute": {
            "description": "Key attribute",
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
          },
          "searchFilter": {
            "description": "Search filter",
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
          },
          "mappings": {
            "type": "array",
            "description": "Group attribute and user traffic profile mapping",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "User traffic profile mapping",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Group attribute mapping UUID"
                },
                "groupAttr": {
                  "type": "string",
                  "description": "Group attribute"
                },
                "userRole": {
                  "type": "object",
                  "additionalProperties": false,
                  "description": "Identity user role",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Identity user role UUID"
                    },
                    "name": {
                      "description": "Identity user role name",
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 64,
                      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
                    },
                    "userTrafficProfile": {
                      "type": "object",
                      "description": "Identity user role",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "User traffic profile UUID"
                        },
                        "name": {
                          "type": "string",
                          "description": "User traffic profile name"
                        }
                      }
                    },
                    "firewallProfileId": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "groupAttr",
                "userRole"
              ]
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve - LDAP Authentication Service

GET/v11_1/services/auth/ldap/{id}

Use this API command to retrieve a LDAP authentication service.

Response  200
HideShow
Body
{
  "id": "18b76a50-6a57-11e4-96af-dc6020524153",
  "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
  "protocol": "LDAP",
  "name": "rapheal-ldap",
  "friendlyName": "",
  "description": "",
  "mappings": [
    {
      "id": "afa788e0-6afd-11e4-b9bb-08002716c79f",
      "groupAttr": "*",
      "userRole": {
        "id": "636431d6-c06e-4692-a28f-3914afc2a817",
        "name": "identity user role name",
        "userTrafficProfile": {
          "id": "fbde8510-6972-11e4-926e-08002716c79f",
          "name": "System Default"
        }
      }
    },
    {
      "id": "afaa4800-6afd-11e4-b9bb-08002716c79f",
      "groupAttr": "abcd",
      "userRole": {
        "id": "636431d6-c06e-4692-a28f-3914afc2a817",
        "name": "identity user role name",
        "userTrafficProfile": {
          "id": "fbde8510-6972-11e4-926e-08002716c79f",
          "name": "System Default"
        }
      }
    }
  ],
  "tlsEnabled": true,
  "clientCertId": "1dde2460-c624-11e8-88b3-000000441962",
  "ip": "1.1.1.122",
  "port": 389,
  "baseDomainName": "dc=ldap",
  "adminDomainName": "uid=ibm",
  "password": "admin",
  "keyAttribute": "uid",
  "searchFilter": "(objectClass=*)"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the LDAP authentication service",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "description": "Name of the LDAP authentication service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "friendlyName": {
      "description": "Friendly name of the LDAP authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "protocol": {
      "description": "Authentication protocol",
      "type": "string",
      "enum": [
        "LDAP"
      ]
    },
    "type": {
      "description": "Authentication protocol same as protocol.",
      "type": "string",
      "enum": [
        "LDAP"
      ]
    },
    "description": {
      "description": "Description of the LDAP authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "tlsEnabled": {
      "description": "LDAP over TLS Enabled",
      "type": "boolean"
    },
    "cnIdentity": {
      "maxLength": 64,
      "type": "string"
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer"
    },
    "baseDomainName": {
      "description": "Base domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 128,
      "pattern": "^[!-~]([ -~]){0,126}[!-~]$"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "keyAttribute": {
      "description": "Key attribute",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "searchFilter": {
      "description": "Search filter",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "id": {
            "type": "string",
            "description": "Group attribute mapping UUID"
          },
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              },
              "userTrafficProfile": {
                "type": "object",
                "description": "Identity user role",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "User traffic profile UUID"
                  },
                  "name": {
                    "type": "string",
                    "description": "User traffic profile name"
                  }
                }
              },
              "firewallProfileId": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Retrieve List - OAuth Authentication Service

GET/v11_1/services/auth/oauth

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

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "c74c5340-ac1b-11e4-8a77-08002716c79f",
      "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "name": "globalOauth",
      "domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
      "protocol": "OAUTH",
      "description": "",
      "mappings": [
        {
          "id": "c76bc220-ac1b-11e4-8a77-08002716c79f",
          "groupAttr": "*",
          "userRole": {
            "id": "ad0c58e3-acf7-42a2-a6a7-5a6216110906",
            "name": "Default",
            "userTrafficProfile": {
              "id": "f63a7ad0-8590-11e4-8051-08002716c79f",
              "name": "System Default"
            }
          }
        }
      ],
      "type": "FACEBOOK",
      "applicationId": "test",
      "applicationSecret": "test",
      "willCollectEmail": true,
      "defaultWhitelistedDomains": [
        "fbcdn-profile-a.akamaihd.net",
        "fbstatic-a.akamaihd.net",
        "www.facebook.com"
      ],
      "whitelistedDomains": [
        "*.facebook.com",
        "ruckus.com"
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for oauth authentication service",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the OAuth authentication service",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "protocol": {
            "description": "Authentication protocol.",
            "type": "string",
            "enum": [
              "FACEBOOK",
              "GOOGLE",
              "LINKEDIN"
            ]
          },
          "type": {
            "description": "OAuth Type, may be GOOGLE, FACEBOOK or LINKEDIN",
            "type": "string",
            "enum": [
              "FACEBOOK",
              "GOOGLE",
              "LINKEDIN"
            ]
          },
          "name": {
            "description": "Name of the OAuth authentication service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "friendlyName": {
            "description": "Friendly name of the oAuth authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
          },
          "description": {
            "description": "Description of the OAuth authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "applicationId": {
            "description": "Application ID",
            "type": "string"
          },
          "applicationSecret": {
            "description": "Application Secret",
            "type": "string"
          },
          "willCollectEmail": {
            "description": "Will collect user's email address",
            "type": "boolean"
          },
          "defaultWhitelistedDomains": {
            "description": "Defualt whitelisted domains",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "whitelistedDomains": {
            "description": "Customized whitelisted domains",
            "type": "array",
            "items": {
              "description": "admin domain name",
              "type": "string"
            }
          },
          "mappings": {
            "type": "array",
            "description": "Group attribute and user traffic profile mapping",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "User traffic profile mapping",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Group attribute mapping UUID"
                },
                "groupAttr": {
                  "type": "string",
                  "description": "Group attribute"
                },
                "userRole": {
                  "type": "object",
                  "additionalProperties": false,
                  "description": "Identity user role",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Identity user role UUID"
                    },
                    "name": {
                      "description": "Identity user role name",
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 64,
                      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
                    },
                    "userTrafficProfile": {
                      "type": "object",
                      "description": "Identity user role",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "User traffic profile UUID"
                        },
                        "name": {
                          "type": "string",
                          "description": "User traffic profile name"
                        }
                      }
                    },
                    "firewallProfileId": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "groupAttr",
                "userRole"
              ]
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve - OAuth Authentication Service

GET/v11_1/services/auth/oauth/{id}

Use this API command to retrieve a OAuth authentication service.

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

Query Non-Proxy Authentication AAAServers

POST/v11_1/query/services/aaaServer/auth

Query Non-Proxy Authentication AAAServers with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "key": "fcdf29e1-e870-4950-a4df-57b80efb5811",
      "type": "RADIUS",
      "name": "aAAServer00001",
      "description": null,
      "authType": "WLAN",
      "radiusRealm": "hinet.net",
      "radiusIP": "172.17.1.1",
      "radiusIPv6": null,
      "radiusPort": 1812,
      "secondaryRadiusIP": "172.18.16.1",
      "secondaryRadiusIPv6": null,
      "secondaryRadiusPort": 1111,
      "enableSecondaryRadius": 1,
      "isConflict": 0,
      "tacacsService": null,
      "tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
      "ip": null,
      "ipv6": null,
      "port": null,
      "adminDomainName": null,
      "domainName": null,
      "windowsDomainName": null,
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "createOn": 1484720653245,
      "creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "admin",
      "zoneUUID": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "globalCatalog": null,
      "modifiedDateTime": 1484720653245,
      "id": "fcdf29e1-e870-4950-a4df-57b80efb5811"
    },
    {
      "key": "4d388f44-10dd-4563-91d7-5886ae0339a3",
      "type": "RADIUS",
      "name": "aAAServer00002",
      "description": null,
      "authType": "WLAN",
      "radiusRealm": "hinet.net",
      "radiusIP": "172.17.1.2",
      "radiusIPv6": null,
      "radiusPort": 1812,
      "secondaryRadiusIP": "172.18.16.2",
      "secondaryRadiusIPv6": null,
      "secondaryRadiusPort": 1111,
      "enableSecondaryRadius": 1,
      "isConflict": 0,
      "tacacsService": null,
      "tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
      "ip": null,
      "ipv6": null,
      "port": null,
      "adminDomainName": null,
      "domainName": null,
      "windowsDomainName": null,
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "createOn": 1484720653245,
      "creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "admin",
      "zoneUUID": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "globalCatalog": null,
      "modifiedDateTime": 1484720653245,
      "id": "4d388f44-10dd-4563-91d7-5886ae0339a3"
    }
  ],
  "extra": {}
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "totalCount": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for AAA server list",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "secondaryRadiusPort": {
            "type": "integer"
          },
          "adminDomainName": {
            "type": "string"
          },
          "creatorUUID": {
            "type": "string"
          },
          "secondaryRadiusIP": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "RADIUS",
              "AD",
              "LDAP",
              "RADIUSAcct",
              "TACACS"
            ]
          },
          "secondaryRadiusIPv6": {
            "type": "string"
          },
          "radiusPort": {
            "type": "integer"
          },
          "ipv6": {
            "type": "string"
          },
          "modifiedDateTime": {
            "type": "integer"
          },
          "authType": {
            "type": "string",
            "enum": [
              "WSG",
              "WLAN"
            ]
          },
          "radiusIP": {
            "type": "string"
          },
          "radiusIPv6": {
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "tenantUUID": {
            "type": "string"
          },
          "enableSecondaryRadius": {
            "type": "integer"
          },
          "modifierUsername": {
            "type": "string"
          },
          "ip": {
            "type": "string"
          },
          "zoneUUID": {
            "type": "string"
          },
          "domainId": {
            "type": "string"
          },
          "tacacsService": {
            "type": "string"
          },
          "port": {
            "type": "integer"
          },
          "radiusRealm": {
            "type": "string"
          },
          "domainName": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "isConflict": {
            "type": "integer"
          },
          "createOn": {
            "type": "integer",
            "format": "int64"
          },
          "globalCatalog": {
            "type": "boolean"
          },
          "windowsDomainName": {
            "type": "string"
          },
          "partnerName": {
            "type": "string"
          },
          "token": {
            "type": "string"
          },
          "authenticationApi": {
            "type": "string"
          },
          "accountingApi": {
            "type": "string"
          },
          "coaResponseApi": {
            "type": "string"
          },
          "coaApi": {
            "type": "string"
          },
          "sseTimeout": {
            "type": "integer"
          }
        }
      }
    }
  }
}

Create - Active Directory Authentication Service

POST/v11_1/services/auth/ad

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

Request
HideShow
Body
{
  "name": "rapheal-ad2",
  "ip": "1.1.1.15",
  "port": 389,
  "windowsDomainName": "dc=domain",
  "globalCatalogEnabled": false,
  "tlsEnabled": false,
  "domainId": "18b76a50-6a57-11e4-96af-dc6020524153"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the authentication service",
      "type": "string"
    },
    "type": {
      "description": "Authentication protocol.",
      "type": "string",
      "enum": [
        "AD"
      ]
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "description": "Name of the active directory authentication service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "friendlyName": {
      "description": "Friendly name of the active directory authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "description": {
      "description": "Description of the active directory authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535,
      "default": 389
    },
    "windowsDomainName": {
      "description": "Windows domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "tlsEnabled": {
      "description": "AD over TLS Enabled",
      "type": "boolean"
    },
    "cnIdentity": {
      "maxLength": 64,
      "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": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  },
  "required": [
    "name",
    "ip",
    "port",
    "windowsDomainName",
    "tlsEnabled",
    "globalCatalogEnabled"
  ]
}
Response  201
HideShow
Body
{
  "id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Retrieve List - LDAP Authentication Service by query criteria

POST/v11_1/services/auth/ldap/query

Use this API command to retrieve a list of LDAP Authentication services by query criteria. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "18b76a50-6a57-11e4-96af-dc6020524153",
      "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
      "protocol": "LDAP",
      "name": "rapheal-ldap",
      "friendlyName": "",
      "description": "",
      "mappings": [
        {
          "id": "afa788e0-6afd-11e4-b9bb-08002716c79f",
          "groupAttr": "*",
          "userRole": {
            "id": "636431d6-c06e-4692-a28f-3914afc2a817",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "fbde8510-6972-11e4-926e-08002716c79f",
              "name": "System Default"
            }
          }
        },
        {
          "id": "afaa4800-6afd-11e4-b9bb-08002716c79f",
          "groupAttr": "abcd",
          "userRole": {
            "id": "636431d6-c06e-4692-a28f-3914afc2a817",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "fbde8510-6972-11e4-926e-08002716c79f",
              "name": "System Default"
            }
          }
        }
      ],
      "tlsEnabled": true,
      "clientCertId": "1dde2460-c624-11e8-88b3-000000441962",
      "ip": "1.1.1.122",
      "port": 389,
      "baseDomainName": "dc=ldap",
      "adminDomainName": "uid=ibm",
      "password": "admin",
      "keyAttribute": "uid",
      "searchFilter": "(objectClass=*)"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for ldap authentication service",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the LDAP authentication service",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "name": {
            "description": "Name of the LDAP authentication service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "friendlyName": {
            "description": "Friendly name of the LDAP authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
          },
          "protocol": {
            "description": "Authentication protocol",
            "type": "string",
            "enum": [
              "LDAP"
            ]
          },
          "type": {
            "description": "Authentication protocol same as protocol.",
            "type": "string",
            "enum": [
              "LDAP"
            ]
          },
          "description": {
            "description": "Description of the LDAP authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "tlsEnabled": {
            "description": "LDAP over TLS Enabled",
            "type": "boolean"
          },
          "cnIdentity": {
            "maxLength": 64,
            "type": "string"
          },
          "ip": {
            "description": "IP address",
            "type": "string"
          },
          "port": {
            "description": "Port",
            "type": "integer"
          },
          "baseDomainName": {
            "description": "Base domain name",
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
          },
          "adminDomainName": {
            "description": "Admin domain name",
            "type": "string",
            "minLength": 2,
            "maxLength": 128,
            "pattern": "^[!-~]([ -~]){0,126}[!-~]$"
          },
          "password": {
            "description": "Admin password",
            "type": "string"
          },
          "keyAttribute": {
            "description": "Key attribute",
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
          },
          "searchFilter": {
            "description": "Search filter",
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
          },
          "mappings": {
            "type": "array",
            "description": "Group attribute and user traffic profile mapping",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "User traffic profile mapping",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Group attribute mapping UUID"
                },
                "groupAttr": {
                  "type": "string",
                  "description": "Group attribute"
                },
                "userRole": {
                  "type": "object",
                  "additionalProperties": false,
                  "description": "Identity user role",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Identity user role UUID"
                    },
                    "name": {
                      "description": "Identity user role name",
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 64,
                      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
                    },
                    "userTrafficProfile": {
                      "type": "object",
                      "description": "Identity user role",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "User traffic profile UUID"
                        },
                        "name": {
                          "type": "string",
                          "description": "User traffic profile name"
                        }
                      }
                    },
                    "firewallProfileId": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "groupAttr",
                "userRole"
              ]
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve List - All types of Authentication Service by query criteria

POST/v11_1/services/auth/query

Use this API command to retrieve a list of Authentication services by query criteria. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "accountingServiceUUID",
      "mvnoId": "userMVNOId",
      "domainId": "userDomainId",
      "name": "accountingServiceName",
      "description": "accountingServiceDescription",
      "protocol": "RADIUS"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for authentication servers",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the authentication service",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "name": {
            "description": "Name of the authentication service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "friendlyName": {
            "description": "Friendly name of the authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
          },
          "description": {
            "description": "Description of the authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "protocol": {
            "description": "Authentication protocol.",
            "type": "string",
            "enum": [
              "RADIUS",
              "AD",
              "LDAP",
              "FACEBOOK",
              "LINKEDIN",
              "GOOGLE",
              "GENERICOAUTH",
              "SOAP",
              "HLR",
              "LOCAL_DB",
              "GUEST"
            ]
          },
          "type": {
            "description": "Authentication protocol same as protocol.",
            "type": "string",
            "enum": [
              "RADIUS",
              "AD",
              "LDAP",
              "FACEBOOK",
              "LINKEDIN",
              "GOOGLE",
              "GENERICOAUTH",
              "SOAP",
              "HLR",
              "LOCAL_DB",
              "GUEST"
            ]
          },
          "mappings": {
            "type": "array",
            "description": "Group attribute and user traffic profile mapping",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "User traffic profile mapping",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Group attribute mapping UUID"
                },
                "groupAttr": {
                  "type": "string",
                  "description": "Group attribute"
                },
                "userRole": {
                  "type": "object",
                  "additionalProperties": false,
                  "description": "Identity user role",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Identity user role UUID"
                    },
                    "name": {
                      "description": "Identity user role name",
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 64,
                      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
                    },
                    "userTrafficProfile": {
                      "type": "object",
                      "description": "Identity user role",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "User traffic profile UUID"
                        },
                        "name": {
                          "type": "string",
                          "description": "User traffic profile name"
                        }
                      }
                    },
                    "firewallProfileId": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "groupAttr",
                "userRole"
              ]
            }
          },
          "tlsEnabled": {
            "type": "boolean"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Test specific authentication Service

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

Use this API command to test an authentication service.

Request
HideShow
Body
{
  "id": "839f87c6-d116-497e-afce-aa8157abdasd",
  "loginRequest": {
    "password": "adsf",
    "userName": "test",
    "timeZoneUtcOffset": "+8",
    "protocol": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the authentication service",
      "type": "string"
    },
    "loginRequest": {
      "type": "object",
      "properties": {
        "password": {
          "description": "password for test user",
          "type": "string"
        },
        "userName": {
          "description": "name for test user",
          "type": "string"
        },
        "timeZoneUtcOffset": {
          "description": "timezone offset, ex: '+8'",
          "type": "string"
        },
        "protocol": {
          "type": "string"
        }
      }
    }
  }
}
Response  200

Retrieve List - Radius Authentication Service by query criteria

POST/v11_1/services/auth/radius/query

Use this API command to retrieve a list of radius Authentication services by query criteria. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "82109ce0-64e6-11e4-8916-0026b9f85aaf",
      "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "userDomainId",
      "protocol": "RADIUS",
      "name": "rapheal-auth-x3",
      "friendlyName": "rapheal-auth-x",
      "description": "authentication service created by rapheal via public API",
      "mappings": [
        {
          "id": "73587760-6589-11e4-800c-0026b9f85aaf",
          "groupAttr": "abc",
          "userRole": {
            "id": "a4c288b0-63cf-11e4-a18a-080027b147d4",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "9474cc20-63cf-11e4-a18a-080027b147d4",
              "name": "rapheal-usertraffic-profile"
            }
          }
        },
        {
          "id": "735e6ad0-6589-11e4-800c-0026b9f85aaf",
          "groupAttr": "*",
          "userRole": {
            "id": "9ac45fd6-a87b-4eef-87d7-b759fed376c5",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "03ec5340-60a4-11e4-87fc-080027b147d4",
              "name": "System Default"
            }
          }
        }
      ],
      "primary": {
        "ip": "1.1.1.155",
        "port": 1812,
        "sharedSecret": "abc"
      },
      "secondary": {
        "ip": "2.2.2.231",
        "port": 1812,
        "sharedSecret": "abc"
      },
      "healthCheckPolicy": {
        "responseWindow": 20,
        "reviveInterval": 120,
        "zombiePeriod": 40
      },
      "rateLimiting": {
        "maxOutstandingRequestsPerServer": 0,
        "threshold": 0,
        "sanityTimer": 10
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for radius authentication",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the RADIUS authentication service",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "name": {
            "description": "Name of the RADIUS authentication service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "friendlyName": {
            "description": "Friendly name of the RADIUS authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
          },
          "protocol": {
            "description": "Authentication protocol.",
            "type": "string",
            "enum": [
              "RADIUS"
            ]
          },
          "type": {
            "description": "Authentication protocol.",
            "type": "string",
            "enum": [
              "RADIUS"
            ]
          },
          "description": {
            "description": "Description of the RADIUS authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "locationDeliveryEnabled": {
            "description": "RFC5580 out of band location delivery support(for Ruckus AP only)",
            "type": "boolean",
            "default": false
          },
          "primary": {
            "description": "Primary RADIUS server",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "type": "string"
              },
              "port": {
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "type": "string"
              },
              "ipFqdn": {
                "type": "string"
              }
            },
            "required": [
              "port",
              "ipFqdn"
            ]
          },
          "secondary": {
            "description": "Secondary RADIUS server",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "autoFallbackDisable": {
                "description": "Automatic fallback enabled or disabled",
                "type": "boolean"
              },
              "ip": {
                "description": "RADIUS server IP",
                "type": "string"
              },
              "port": {
                "description": "RADIUS server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535,
                "default": 1812
              },
              "sharedSecret": {
                "description": "RADIUS server shared secret",
                "type": "string"
              },
              "ipFqdn": {
                "description": "RADIUS server IP address or FQDN",
                "type": "string"
              }
            },
            "required": [
              "autoFallbackDisable",
              "port",
              "sharedSecret",
              "ipFqdn"
            ]
          },
          "healthCheckPolicy": {
            "description": "Health check policy",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "responseWindow": {
                "description": "Response window",
                "type": "integer",
                "minimum": 5,
                "maximum": 30,
                "default": 20
              },
              "reviveInterval": {
                "description": "Revive interval",
                "type": "integer",
                "minimum": 60,
                "maximum": 3600,
                "default": 120
              },
              "zombiePeriod": {
                "description": "Zombie period",
                "type": "integer",
                "minimum": 30,
                "maximum": 120,
                "default": 40
              },
              "responseFail": {
                "description": "Response Fail",
                "type": "boolean",
                "default": "false"
              }
            },
            "required": [
              "responseWindow",
              "reviveInterval",
              "zombiePeriod"
            ]
          },
          "rateLimiting": {
            "description": "Rate limiting",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "maxOutstandingRequestsPerServer": {
                "description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
                "type": "integer",
                "default": 0
              },
              "threshold": {
                "description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
                "type": "integer",
                "default": 0
              },
              "sanityTimer": {
                "description": "Sanity timer",
                "type": "integer",
                "minimum": 1,
                "maximum": 3600,
                "default": 10
              }
            },
            "required": [
              "maxOutstandingRequestsPerServer",
              "threshold",
              "sanityTimer"
            ]
          },
          "mappings": {
            "type": "array",
            "description": "Group attribute and user traffic profile mapping",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "User traffic profile mapping",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Group attribute mapping UUID"
                },
                "groupAttr": {
                  "type": "string",
                  "description": "Group attribute"
                },
                "userRole": {
                  "type": "object",
                  "additionalProperties": false,
                  "description": "Identity user role",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Identity user role UUID"
                    },
                    "name": {
                      "description": "Identity user role name",
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 64,
                      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
                    },
                    "userTrafficProfile": {
                      "type": "object",
                      "description": "Identity user role",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "User traffic profile UUID"
                        },
                        "name": {
                          "type": "string",
                          "description": "User traffic profile name"
                        }
                      }
                    },
                    "firewallProfileId": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "groupAttr",
                "userRole"
              ]
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          },
          "tlsEnabled": {
            "description": "TLS Enabled",
            "type": "boolean"
          },
          "ocspUrl": {
            "type": "string",
            "maxLength": 1024
          },
          "cnSanIdentity": {
            "type": "string",
            "maxLength": 1023
          },
          "clientCertId": {
            "type": "string"
          },
          "serverCertId": {
            "type": "string"
          },
          "standbyTlsEnabled": {
            "type": "boolean"
          },
          "standbyOcspUrl": {
            "type": "string",
            "maxLength": 1024
          },
          "standbyCnSanIdentity": {
            "type": "string",
            "maxLength": 1023
          },
          "standbyClientCertId": {
            "type": "string"
          },
          "standbyServerCertId": {
            "type": "string"
          }
        }
      }
    }
  }
}

Create - RADIUS Authentication Service

POST/v11_1/services/auth/radius

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

Request
HideShow
Body
{
  "name": "authenticationServiceName",
  "domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
  "primary": {
    "ip": "192.168.1.1",
    "port": 1812,
    "sharedSecret": "abc"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the authentication service",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "description": "Name of the RADIUS authentication service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "friendlyName": {
      "description": "Friendly name of the RADIUS authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "description": {
      "description": "Description of the RADIUS authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "locationDeliveryEnabled": {
      "description": "RFC5580 out of band location delivery support(for Ruckus AP only)",
      "type": "boolean",
      "default": false
    },
    "type": {
      "description": "Authentication protocol",
      "type": "string",
      "enum": [
        "RADIUS"
      ]
    },
    "primary": {
      "description": "Primary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string"
        },
        "port": {
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "type": "string"
        },
        "ipFqdn": {
          "type": "string"
        }
      },
      "required": [
        "port",
        "ipFqdn"
      ]
    },
    "secondary": {
      "description": "Secondary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoFallbackDisable": {
          "description": "Automatic fallback enabled or disabled",
          "type": "boolean"
        },
        "ip": {
          "description": "RADIUS server IP",
          "type": "string"
        },
        "port": {
          "description": "RADIUS server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535,
          "default": 1812
        },
        "sharedSecret": {
          "description": "RADIUS server shared secret",
          "type": "string"
        },
        "ipFqdn": {
          "description": "RADIUS server IP address or FQDN",
          "type": "string"
        }
      },
      "required": [
        "autoFallbackDisable",
        "port",
        "sharedSecret",
        "ipFqdn"
      ]
    },
    "healthCheckPolicy": {
      "description": "Health check policy",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "responseWindow": {
          "description": "Response window",
          "type": "integer",
          "minimum": 5,
          "maximum": 30,
          "default": 20
        },
        "reviveInterval": {
          "description": "Revive interval",
          "type": "integer",
          "minimum": 60,
          "maximum": 3600,
          "default": 120
        },
        "zombiePeriod": {
          "description": "Zombie period",
          "type": "integer",
          "minimum": 30,
          "maximum": 120,
          "default": 40
        },
        "responseFail": {
          "description": "Response Fail",
          "type": "boolean",
          "default": "false"
        }
      },
      "required": [
        "responseWindow",
        "reviveInterval",
        "zombiePeriod"
      ]
    },
    "rateLimiting": {
      "description": "Rate limiting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "maxOutstandingRequestsPerServer": {
          "description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
          "type": "integer",
          "default": 0
        },
        "threshold": {
          "description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
          "type": "integer",
          "default": 0
        },
        "sanityTimer": {
          "description": "Sanity timer",
          "type": "integer",
          "minimum": 1,
          "maximum": 3600,
          "default": 10
        }
      },
      "required": [
        "maxOutstandingRequestsPerServer",
        "threshold",
        "sanityTimer"
      ]
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "tlsEnabled": {
      "description": "TLS Enabled",
      "type": "boolean",
      "default": false
    },
    "ocspUrl": {
      "type": "string",
      "maxLength": 1024
    },
    "cnSanIdentity": {
      "type": "string",
      "maxLength": 1023
    },
    "clientCertId": {
      "type": "string"
    },
    "serverCertId": {
      "type": "string"
    },
    "standbyTlsEnabled": {
      "type": "boolean"
    },
    "standbyOcspUrl": {
      "type": "string",
      "maxLength": 1024
    },
    "standbyCnSanIdentity": {
      "type": "string",
      "maxLength": 1023
    },
    "standbyClientCertId": {
      "type": "string"
    },
    "standbyServerCertId": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "primary"
  ]
}
Response  201
HideShow
Body
{
  "id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Retrieve List - AD Authentication Service by query criteria

POST/v11_1/services/auth/ad/query

Use this API command to retrieve a list of AD Authentication services by query criteria. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "49322250-6afd-11e4-832a-dc6020524153",
      "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "userDomainId",
      "protocol": "AD",
      "name": "rapheal-ad",
      "friendlyName": "",
      "description": "",
      "mappings": [
        {
          "id": "c7608860-6afd-11e4-b9bb-08002716c79f",
          "groupAttr": "*",
          "userRole": {
            "id": "636431d6-c06e-4692-a28f-3914afc2a817",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "fbde8510-6972-11e4-926e-08002716c79f",
              "name": "System Default"
            }
          }
        }
      ],
      "ip": "1.1.1.1",
      "port": 3268,
      "windowsDomainName": "dc=domain",
      "adminDomainName": "[email protected]",
      "password": "abced",
      "globalCatalogEnabled": true
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for AD authentication service",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the active directory authentication service",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "protocol": {
            "description": "Authentication protocol.",
            "type": "string",
            "enum": [
              "AD"
            ]
          },
          "type": {
            "description": "Authentication protocol.",
            "type": "string",
            "enum": [
              "AD"
            ]
          },
          "name": {
            "description": "Name of the active directory authentication service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "friendlyName": {
            "description": "Friendly name of the active directory authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
          },
          "description": {
            "description": "Description of the active directory authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "ip": {
            "description": "IP address",
            "type": "string"
          },
          "port": {
            "description": "Port",
            "type": "integer",
            "minimum": 1,
            "maximum": 65535,
            "default": 389
          },
          "windowsDomainName": {
            "description": "Windows domain name",
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
          },
          "adminDomainName": {
            "description": "Admin domain name",
            "type": "string",
            "minLength": 2,
            "maxLength": 64,
            "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
          },
          "password": {
            "description": "Admin password",
            "type": "string"
          },
          "tlsEnabled": {
            "description": "AD over TLS Enabled",
            "type": "boolean"
          },
          "cnIdentity": {
            "maxLength": 64,
            "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": {
                      "description": "Identity user role name",
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 64,
                      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
                    },
                    "userTrafficProfile": {
                      "type": "object",
                      "description": "Identity user role",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "User traffic profile UUID"
                        },
                        "name": {
                          "type": "string",
                          "description": "User traffic profile name"
                        }
                      }
                    },
                    "firewallProfileId": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "groupAttr",
                "userRole"
              ]
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Create - LDAP Authentication Service

POST/v11_1/services/auth/ldap

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

Request
HideShow
Body
{
  "name": "rapheal-ldap",
  "domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
  "tlsEnabled": true,
  "clientCertId": "1dde2460-c624-11e8-88b3-000000441962",
  "ip": "1.1.1.1",
  "port": 389,
  "baseDomainName": "dc=ldap",
  "adminDomainName": "uid=ibm",
  "password": "admin",
  "keyAttribute": "uid",
  "searchFilter": "(objectClass=*)"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the authentication service",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "description": "Name of the LDAP authentication service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "friendlyName": {
      "description": "Friendly name of the LDAP authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "type": {
      "description": "Authentication protocol.",
      "type": "string",
      "enum": [
        "LDAP"
      ]
    },
    "description": {
      "description": "Description of the LDAP authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "tlsEnabled": {
      "description": "LDAP over TLS Enabled",
      "type": "boolean"
    },
    "cnIdentity": {
      "maxLength": 64,
      "type": "string"
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535,
      "default": 389
    },
    "baseDomainName": {
      "description": "Base domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 128,
      "pattern": "^[!-~]([ -~]){0,126}[!-~]$"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "keyAttribute": {
      "description": "Key attribute",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "searchFilter": {
      "description": "Search filter",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  },
  "required": [
    "name",
    "tlsEnabled",
    "ip",
    "port",
    "baseDomainName",
    "adminDomainName",
    "password",
    "keyAttribute",
    "searchFilter"
  ]
}
Response  201
HideShow
Body
{
  "id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Retrieve List - oAuth Authentication Service by query criteria

POST/v11_1/services/auth/oauth/query

Use this API command to retrieve a list of oAuth Authentication services by query criteria. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "c74c5340-ac1b-11e4-8a77-08002716c79f",
      "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "name": "globalOauth",
      "domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
      "protocol": "OAUTH",
      "description": "",
      "mappings": [
        {
          "id": "c76bc220-ac1b-11e4-8a77-08002716c79f",
          "groupAttr": "*",
          "userRole": {
            "id": "ad0c58e3-acf7-42a2-a6a7-5a6216110906",
            "name": "Default",
            "userTrafficProfile": {
              "id": "f63a7ad0-8590-11e4-8051-08002716c79f",
              "name": "System Default"
            }
          }
        }
      ],
      "type": "FACEBOOK",
      "applicationId": "test",
      "applicationSecret": "test",
      "willCollectEmail": true,
      "defaultWhitelistedDomains": [
        "fbcdn-profile-a.akamaihd.net",
        "fbstatic-a.akamaihd.net",
        "www.facebook.com"
      ],
      "whitelistedDomains": [
        "*.facebook.com",
        "ruckus.com"
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for oauth authentication service",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the OAuth authentication service",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "protocol": {
            "description": "Authentication protocol.",
            "type": "string",
            "enum": [
              "FACEBOOK",
              "GOOGLE",
              "LINKEDIN"
            ]
          },
          "type": {
            "description": "OAuth Type, may be GOOGLE, FACEBOOK or LINKEDIN",
            "type": "string",
            "enum": [
              "FACEBOOK",
              "GOOGLE",
              "LINKEDIN"
            ]
          },
          "name": {
            "description": "Name of the OAuth authentication service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "friendlyName": {
            "description": "Friendly name of the oAuth authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
          },
          "description": {
            "description": "Description of the OAuth authentication service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "applicationId": {
            "description": "Application ID",
            "type": "string"
          },
          "applicationSecret": {
            "description": "Application Secret",
            "type": "string"
          },
          "willCollectEmail": {
            "description": "Will collect user's email address",
            "type": "boolean"
          },
          "defaultWhitelistedDomains": {
            "description": "Defualt whitelisted domains",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "whitelistedDomains": {
            "description": "Customized whitelisted domains",
            "type": "array",
            "items": {
              "description": "admin domain name",
              "type": "string"
            }
          },
          "mappings": {
            "type": "array",
            "description": "Group attribute and user traffic profile mapping",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "User traffic profile mapping",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Group attribute mapping UUID"
                },
                "groupAttr": {
                  "type": "string",
                  "description": "Group attribute"
                },
                "userRole": {
                  "type": "object",
                  "additionalProperties": false,
                  "description": "Identity user role",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Identity user role UUID"
                    },
                    "name": {
                      "description": "Identity user role name",
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 64,
                      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
                    },
                    "userTrafficProfile": {
                      "type": "object",
                      "description": "Identity user role",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "User traffic profile UUID"
                        },
                        "name": {
                          "type": "string",
                          "description": "User traffic profile name"
                        }
                      }
                    },
                    "firewallProfileId": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "groupAttr",
                "userRole"
              ]
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Modify Entire - RADIUS Authentication Service

PUT/v11_1/services/auth/radius/{id}

Use this API command to modify entire RADIUS authentication service.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "friendlyName": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "locationDeliveryEnabled": {
      "description": "RFC5580 out of band location delivery support(for Ruckus AP only)",
      "type": "boolean"
    },
    "type": {
      "description": "Authentication server type",
      "type": "string",
      "enum": [
        "RADIUS"
      ]
    },
    "primary": {
      "description": "Primary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string"
        },
        "port": {
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "type": "string"
        },
        "ipFqdn": {
          "type": "string"
        }
      },
      "required": [
        "port",
        "ipFqdn"
      ]
    },
    "secondary": {
      "description": "Secondary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoFallbackDisable": {
          "description": "Automatic fallback enabled or disabled",
          "type": "boolean"
        },
        "ip": {
          "description": "RADIUS server IP",
          "type": "string"
        },
        "port": {
          "description": "RADIUS server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "RADIUS server shared secret",
          "type": "string"
        },
        "ipFqdn": {
          "description": "RADIUS server IP address or FQDN",
          "type": "string"
        }
      },
      "required": [
        "autoFallbackDisable",
        "port",
        "sharedSecret",
        "ipFqdn"
      ]
    },
    "healthCheckPolicy": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "responseWindow": {
          "description": "Response window",
          "type": "integer",
          "minimum": 5,
          "maximum": 30
        },
        "reviveInterval": {
          "description": "Revive interval",
          "type": "integer",
          "minimum": 60,
          "maximum": 3600
        },
        "zombiePeriod": {
          "description": "Zombie period",
          "type": "integer",
          "minimum": 30,
          "maximum": 120
        },
        "responseFail": {
          "description": "Response Fail",
          "type": "boolean"
        }
      },
      "required": [
        "responseWindow",
        "reviveInterval",
        "zombiePeriod"
      ]
    },
    "rateLimiting": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "maxOutstandingRequestsPerServer": {
          "description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
          "type": "integer"
        },
        "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"
        },
        "sanityTimer": {
          "description": "Sanity timer",
          "type": "integer",
          "minimum": 1,
          "maximum": 3600
        }
      },
      "required": [
        "maxOutstandingRequestsPerServer",
        "threshold",
        "sanityTimer"
      ]
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "tlsEnabled": {
      "type": "boolean"
    },
    "ocspUrl": {
      "type": "string",
      "maxLength": 1024
    },
    "cnSanIdentity": {
      "type": "string",
      "maxLength": 1023
    },
    "clientCertId": {
      "type": "string"
    },
    "serverCertId": {
      "type": "string"
    },
    "standbyTlsEnabled": {
      "type": "boolean"
    },
    "standbyOcspUrl": {
      "type": "string",
      "maxLength": 1024
    },
    "standbyCnSanIdentity": {
      "type": "string",
      "maxLength": 1023
    },
    "standbyClientCertId": {
      "type": "string"
    },
    "standbyServerCertId": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "type",
    "primary",
    "rateLimiting"
  ]
}
Response  204

Modify - Active Directory Authentication Service

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

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

Request
HideShow
Body
{
  "adminDomainName": "[email protected]",
  "password": "newpassword",
  "globalCatalogEnabled": true,
  "mappings": [
    {
      "groupAttr": "newGroupAttr",
      "userRole": {
        "id": "identity user role UUID"
      }
    },
    {
      "groupAttr": "*",
      "userRole": {
        "name": "identity user role name"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the authentication service",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "description": "Name of the active directory authentication service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "friendlyName": {
      "description": "Friendly name of the active directory authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "description": {
      "description": "Description of the active directory authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "type": {
      "description": "Authentication protocol.",
      "type": "string",
      "enum": [
        "AD"
      ]
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "windowsDomainName": {
      "description": "Windows domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "tlsEnabled": {
      "description": "AD over TLS Enabled",
      "type": "boolean"
    },
    "cnIdentity": {
      "maxLength": 64,
      "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": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  }
}
Response  204

Update LocalDB Authentication Service

PATCH/v11_1/services/auth/local_db/{id}

Use this API command to update LocalDB authentication service.

Request
HideShow
Body
{
  "domainId": "8b3881d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "local db",
  "friendlyName": "aaa",
  "description": "ddd",
  "type": "LOCAL_DB",
  "mvnoId": "897f87c6-d116-497e-afce-aa8157abd30c",
  "mappings": [
    {
      "groupAttr": "groupAttr",
      "userRole": {
        "id": "id",
        "name": "name"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the authentication service",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "description": "Name of the RADIUS authentication service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "friendlyName": {
      "description": "Friendly name of the authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "description": {
      "description": "Description of the authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "protocol": {
      "description": "Authentication protocol.",
      "type": "string",
      "enum": [
        "LOCAL_DB"
      ]
    },
    "type": {
      "description": "Authentication protocol.",
      "type": "string",
      "enum": [
        "LOCAL_DB"
      ]
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  }
}
Response  204

Modify - RADIUS Authentication Service

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

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

Request
HideShow
Body
{
  "name": "new name",
  "description": "new description",
  "mappings": [
    {
      "groupAttr": "newGroupAttr",
      "userRole": {
        "id": "identity user role UUID"
      }
    },
    {
      "groupAttr": "*",
      "userRole": {
        "name": "identity user role name"
      }
    }
  ],
  "primary": {
    "ip": "1.1.1.155",
    "port": 1812,
    "sharedSecret": "abc"
  },
  "secondary": {
    "autoFallbackDisable": false,
    "ip": "2.2.2.231",
    "port": 1812,
    "sharedSecret": "abc"
  },
  "healthCheckPolicy": {
    "responseWindow": 20,
    "reviveInterval": 120,
    "zombiePeriod": 40
  },
  "rateLimiting": {
    "maxOutstandingRequestsPerServer": 0,
    "threshold": 0,
    "sanityTimer": 10
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the authentication service",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "description": "Name of the RADIUS authentication service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "friendlyName": {
      "description": "Friendly name of the RADIUS authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "description": {
      "description": "Description of the RADIUS authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "locationDeliveryEnabled": {
      "description": "RFC5580 out of band location delivery support(for Ruckus AP only)",
      "type": "boolean"
    },
    "type": {
      "description": "Authentication server type",
      "type": "string",
      "enum": [
        "RADIUS"
      ]
    },
    "primary": {
      "description": "Primary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string"
        },
        "port": {
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "type": "string"
        },
        "ipFqdn": {
          "type": "string"
        }
      },
      "required": [
        "port",
        "ipFqdn"
      ]
    },
    "secondary": {
      "description": "Secondary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoFallbackDisable": {
          "description": "Automatic fallback enabled or disabled",
          "type": "boolean"
        },
        "ip": {
          "description": "RADIUS server IP",
          "type": "string"
        },
        "port": {
          "description": "RADIUS server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "RADIUS server shared secret",
          "type": "string"
        },
        "ipFqdn": {
          "description": "RADIUS server IP address or FQDN",
          "type": "string"
        }
      },
      "required": [
        "autoFallbackDisable",
        "port",
        "sharedSecret",
        "ipFqdn"
      ]
    },
    "healthCheckPolicy": {
      "description": "Health check policy",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "responseWindow": {
          "description": "Response window",
          "type": "integer",
          "minimum": 5,
          "maximum": 30
        },
        "reviveInterval": {
          "description": "Revive interval",
          "type": "integer",
          "minimum": 60,
          "maximum": 3600
        },
        "zombiePeriod": {
          "description": "Zombie period",
          "type": "integer",
          "minimum": 30,
          "maximum": 120
        },
        "responseFail": {
          "description": "Response Fail",
          "type": "boolean"
        }
      },
      "required": [
        "responseWindow",
        "reviveInterval",
        "zombiePeriod"
      ]
    },
    "rateLimiting": {
      "description": "Rate limiting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "maxOutstandingRequestsPerServer": {
          "description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
          "type": "integer"
        },
        "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"
        },
        "sanityTimer": {
          "description": "Sanity timer",
          "type": "integer",
          "minimum": 1,
          "maximum": 3600
        }
      },
      "required": [
        "maxOutstandingRequestsPerServer",
        "threshold",
        "sanityTimer"
      ]
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "tlsEnabled": {
      "description": "TLS Enabled",
      "type": "boolean"
    },
    "ocspUrl": {
      "type": "string",
      "maxLength": 1024
    },
    "cnSanIdentity": {
      "type": "string",
      "maxLength": 1023
    },
    "clientCertId": {
      "type": "string"
    },
    "serverCertId": {
      "type": "string"
    },
    "standbyTlsEnabled": {
      "type": "boolean"
    },
    "standbyOcspUrl": {
      "type": "string",
      "maxLength": 1024
    },
    "standbyCnSanIdentity": {
      "type": "string",
      "maxLength": 1023
    },
    "standbyClientCertId": {
      "type": "string"
    },
    "standbyServerCertId": {
      "type": "string"
    }
  }
}
Response  204

Modify - LDAP Authentication Service

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

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

Request
HideShow
Body
{
  "friendlyName": "new name",
  "description": "new description",
  "tlsEnabled": true,
  "clientCertId": "1dde2460-c624-11e8-88b3-000000441962",
  "mappings": [
    {
      "groupAttr": "newGroupAttr",
      "userRole": {
        "id": "identity user role UUID"
      }
    },
    {
      "groupAttr": "*",
      "userRole": {
        "name": "identity user role name"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the authentication service",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "description": "Name of the LDAP authentication service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "friendlyName": {
      "description": "Friendly name of the LDAP authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "description": {
      "description": "Description of the LDAP authentication service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "type": {
      "description": "Authentication protocol same as protocol.",
      "type": "string",
      "enum": [
        "LDAP"
      ]
    },
    "tlsEnabled": {
      "description": "LDAP over TLS Enabled",
      "type": "boolean"
    },
    "cnIdentity": {
      "maxLength": 64,
      "type": "string"
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "baseDomainName": {
      "description": "Base domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 128,
      "pattern": "^[!-~]([ -~]){0,126}[!-~]$"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "keyAttribute": {
      "description": "Key attribute",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "searchFilter": {
      "description": "Search filter",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    }
  }
}
Response  204

Modify - OAuth Authentication Service

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

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

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

Delete - Active Directory Authentication Service

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

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

Response  204

Delete authentication Service

DELETE/v11_1/services/auth/{id}

Use this API command to delete an authentication service.

Response  204

Delete a list of authentication Service

DELETE/v11_1/services/auth

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

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

Delete - RADIUS Authentication Service

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

Use this API command to delete a RADIUS authentication service.

Response  204

Disable Secondary RADIUS Server of Authentication Service

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

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

Response  204

Delete - LDAP Authentication Service

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

Use this API command to delete a LDAP authentication service.

Response  204

Delete - OAuth Authentication Service

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

Use this API command to delete an OAuth authentication service.

Response  204

Accounting Service

Retrieve List - RADIUS Accounting Service

GET/v11_1/services/acct/radius

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

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "accountingServiceUUID",
      "mvnoId": "userMVNOId",
      "domainId": "userDomainId",
      "name": "accountingServiceName",
      "protocol": "RADIUS",
      "description": "accountingServiceDescription",
      "primary": {
        "ip": "192.168.1.1",
        "port": 1812,
        "sharedSecret": "sharedSecret"
      },
      "secondary": {
        "ip": "192.168.1.2",
        "port": 1812,
        "sharedSecret": "sharedSecret"
      },
      "healthCheckPolicy": {
        "responseWindow": 20,
        "reviveInterval": 120,
        "zombiePeriod": 40
      },
      "rateLimiting": {
        "maxOutstandingRequestsPerServer": 0,
        "threshold": 0,
        "sanityTimer": 10
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for radius accounting server",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the RADIUS accounting service",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "protocol": {
            "description": "Accounting protocol.",
            "type": "string",
            "enum": [
              "RADIUS"
            ]
          },
          "type": {
            "description": "Accounting protocol.",
            "type": "string",
            "enum": [
              "RADIUS"
            ]
          },
          "name": {
            "description": "Name of the RADIUS accounting service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the RADIUS accounting service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "primary": {
            "description": "Primary RADIUS server",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "type": "string"
              },
              "port": {
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "type": "string"
              },
              "ipFqdn": {
                "type": "string"
              }
            },
            "required": [
              "port",
              "ipFqdn"
            ]
          },
          "secondary": {
            "description": "Secondary RADIUS server",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "autoFallbackDisable": {
                "description": "Automatic fallback enabled or disabled",
                "type": "boolean"
              },
              "ip": {
                "description": "RADIUS server IP",
                "type": "string"
              },
              "port": {
                "description": "RADIUS server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535,
                "default": 1812
              },
              "sharedSecret": {
                "description": "RADIUS server shared secret",
                "type": "string"
              },
              "ipFqdn": {
                "description": "RADIUS server IP address or FQDN",
                "type": "string"
              }
            },
            "required": [
              "autoFallbackDisable",
              "port",
              "sharedSecret",
              "ipFqdn"
            ]
          },
          "healthCheckPolicy": {
            "description": "Health check policy",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "responseWindow": {
                "description": "Response window",
                "type": "integer",
                "minimum": 5,
                "maximum": 30,
                "default": 20
              },
              "reviveInterval": {
                "description": "Revive interval",
                "type": "integer",
                "minimum": 60,
                "maximum": 3600,
                "default": 120
              },
              "zombiePeriod": {
                "description": "Zombie period",
                "type": "integer",
                "minimum": 30,
                "maximum": 120,
                "default": 40
              },
              "responseFail": {
                "description": "Response Fail",
                "type": "boolean",
                "default": "false"
              }
            },
            "required": [
              "responseWindow",
              "reviveInterval",
              "zombiePeriod"
            ]
          },
          "rateLimiting": {
            "description": "Rate limiting",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "maxOutstandingRequestsPerServer": {
                "description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
                "type": "integer",
                "default": 0
              },
              "threshold": {
                "description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
                "type": "integer",
                "default": 0
              },
              "sanityTimer": {
                "description": "Sanity timer",
                "type": "integer",
                "minimum": 1,
                "maximum": 3600,
                "default": 10
              }
            },
            "required": [
              "maxOutstandingRequestsPerServer",
              "threshold",
              "sanityTimer"
            ]
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          },
          "tlsEnabled": {
            "type": "boolean"
          },
          "ocspUrl": {
            "type": "string",
            "maxLength": 1024
          },
          "cnSanIdentity": {
            "type": "string",
            "maxLength": 1023
          },
          "clientCertId": {
            "type": "string"
          },
          "serverCertId": {
            "type": "string"
          },
          "standbyTlsEnabled": {
            "type": "boolean"
          },
          "standbyOcspUrl": {
            "type": "string",
            "maxLength": 1024
          },
          "standbyCnSanIdentity": {
            "type": "string",
            "maxLength": 1023
          },
          "standbyClientCertId": {
            "type": "string"
          },
          "standbyServerCertId": {
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve - RADIUS Accounting Service

GET/v11_1/services/acct/radius/{id}

Use this API command to retrieve a RADIUS accounting service.

Response  200
HideShow
Body
{
  "id": "accountingServiceUUID",
  "mvnoId": "userMVNOId",
  "domainId": "userDomainId",
  "protocol": "RADIUS",
  "name": "accountingServiceName",
  "description": "accountingServiceDescription",
  "primary": {
    "ip": "192.168.1.1",
    "port": 1812,
    "sharedSecret": "sharedSecret"
  },
  "secondary": {
    "ip": "192.168.1.2",
    "port": 1812,
    "sharedSecret": "sharedSecret"
  },
  "healthCheckPolicy": {
    "responseWindow": 20,
    "reviveInterval": 120,
    "zombiePeriod": 40
  },
  "rateLimiting": {
    "maxOutstandingRequestsPerServer": 0,
    "threshold": 0,
    "sanityTimer": 10
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the RADIUS accounting service",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "protocol": {
      "description": "Accounting protocol.",
      "type": "string",
      "enum": [
        "RADIUS"
      ]
    },
    "type": {
      "description": "Accounting protocol.",
      "type": "string",
      "enum": [
        "RADIUS"
      ]
    },
    "name": {
      "description": "Name of the RADIUS accounting service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the RADIUS accounting service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "primary": {
      "description": "Primary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string"
        },
        "port": {
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "type": "string"
        },
        "ipFqdn": {
          "type": "string"
        }
      },
      "required": [
        "port",
        "ipFqdn"
      ]
    },
    "secondary": {
      "description": "Secondary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoFallbackDisable": {
          "description": "Automatic fallback enabled or disabled",
          "type": "boolean"
        },
        "ip": {
          "description": "RADIUS server IP",
          "type": "string"
        },
        "port": {
          "description": "RADIUS server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535,
          "default": 1812
        },
        "sharedSecret": {
          "description": "RADIUS server shared secret",
          "type": "string"
        },
        "ipFqdn": {
          "description": "RADIUS server IP address or FQDN",
          "type": "string"
        }
      },
      "required": [
        "autoFallbackDisable",
        "port",
        "sharedSecret",
        "ipFqdn"
      ]
    },
    "healthCheckPolicy": {
      "description": "Health check policy",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "responseWindow": {
          "description": "Response window",
          "type": "integer",
          "minimum": 5,
          "maximum": 30,
          "default": 20
        },
        "reviveInterval": {
          "description": "Revive interval",
          "type": "integer",
          "minimum": 60,
          "maximum": 3600,
          "default": 120
        },
        "zombiePeriod": {
          "description": "Zombie period",
          "type": "integer",
          "minimum": 30,
          "maximum": 120,
          "default": 40
        },
        "responseFail": {
          "description": "Response Fail",
          "type": "boolean",
          "default": "false"
        }
      },
      "required": [
        "responseWindow",
        "reviveInterval",
        "zombiePeriod"
      ]
    },
    "rateLimiting": {
      "description": "Rate limiting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "maxOutstandingRequestsPerServer": {
          "description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
          "type": "integer",
          "default": 0
        },
        "threshold": {
          "description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
          "type": "integer",
          "default": 0
        },
        "sanityTimer": {
          "description": "Sanity timer",
          "type": "integer",
          "minimum": 1,
          "maximum": 3600,
          "default": 10
        }
      },
      "required": [
        "maxOutstandingRequestsPerServer",
        "threshold",
        "sanityTimer"
      ]
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    },
    "tlsEnabled": {
      "type": "boolean"
    },
    "ocspUrl": {
      "type": "string",
      "maxLength": 1024
    },
    "cnSanIdentity": {
      "type": "string",
      "maxLength": 1023
    },
    "clientCertId": {
      "type": "string"
    },
    "serverCertId": {
      "type": "string"
    },
    "standbyTlsEnabled": {
      "type": "boolean"
    },
    "standbyOcspUrl": {
      "type": "string",
      "maxLength": 1024
    },
    "standbyCnSanIdentity": {
      "type": "string",
      "maxLength": 1023
    },
    "standbyClientCertId": {
      "type": "string"
    },
    "standbyServerCertId": {
      "type": "string"
    }
  }
}

Query Non-Proxy Accounting AAAServers

POST/v11_1/query/services/aaaServer/acct

Query Non-Proxy Accounting AAAServers with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "key": "fcdf29e1-e870-4950-a4df-57b80efb5811",
      "type": "RADIUS",
      "name": "aAAServer00001",
      "description": null,
      "authType": "WLAN",
      "radiusRealm": "hinet.net",
      "radiusIP": "172.17.1.1",
      "radiusIPv6": null,
      "radiusPort": 1812,
      "secondaryRadiusIP": "172.18.16.1",
      "secondaryRadiusIPv6": null,
      "secondaryRadiusPort": 1111,
      "enableSecondaryRadius": 1,
      "isConflict": 0,
      "tacacsService": null,
      "tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
      "ip": null,
      "ipv6": null,
      "port": null,
      "adminDomainName": null,
      "domainName": null,
      "windowsDomainName": null,
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "createOn": 1484720653245,
      "creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "admin",
      "zoneUUID": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "globalCatalog": null,
      "modifiedDateTime": 1484720653245,
      "id": "fcdf29e1-e870-4950-a4df-57b80efb5811"
    },
    {
      "key": "4d388f44-10dd-4563-91d7-5886ae0339a3",
      "type": "RADIUS",
      "name": "aAAServer00002",
      "description": null,
      "authType": "WLAN",
      "radiusRealm": "hinet.net",
      "radiusIP": "172.17.1.2",
      "radiusIPv6": null,
      "radiusPort": 1812,
      "secondaryRadiusIP": "172.18.16.2",
      "secondaryRadiusIPv6": null,
      "secondaryRadiusPort": 1111,
      "enableSecondaryRadius": 1,
      "isConflict": 0,
      "tacacsService": null,
      "tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
      "ip": null,
      "ipv6": null,
      "port": null,
      "adminDomainName": null,
      "domainName": null,
      "windowsDomainName": null,
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "createOn": 1484720653245,
      "creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "admin",
      "zoneUUID": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "globalCatalog": null,
      "modifiedDateTime": 1484720653245,
      "id": "4d388f44-10dd-4563-91d7-5886ae0339a3"
    }
  ],
  "extra": {}
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "totalCount": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for AAA server list",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "secondaryRadiusPort": {
            "type": "integer"
          },
          "adminDomainName": {
            "type": "string"
          },
          "creatorUUID": {
            "type": "string"
          },
          "secondaryRadiusIP": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "RADIUS",
              "AD",
              "LDAP",
              "RADIUSAcct",
              "TACACS"
            ]
          },
          "secondaryRadiusIPv6": {
            "type": "string"
          },
          "radiusPort": {
            "type": "integer"
          },
          "ipv6": {
            "type": "string"
          },
          "modifiedDateTime": {
            "type": "integer"
          },
          "authType": {
            "type": "string",
            "enum": [
              "WSG",
              "WLAN"
            ]
          },
          "radiusIP": {
            "type": "string"
          },
          "radiusIPv6": {
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "tenantUUID": {
            "type": "string"
          },
          "enableSecondaryRadius": {
            "type": "integer"
          },
          "modifierUsername": {
            "type": "string"
          },
          "ip": {
            "type": "string"
          },
          "zoneUUID": {
            "type": "string"
          },
          "domainId": {
            "type": "string"
          },
          "tacacsService": {
            "type": "string"
          },
          "port": {
            "type": "integer"
          },
          "radiusRealm": {
            "type": "string"
          },
          "domainName": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "isConflict": {
            "type": "integer"
          },
          "createOn": {
            "type": "integer",
            "format": "int64"
          },
          "globalCatalog": {
            "type": "boolean"
          },
          "windowsDomainName": {
            "type": "string"
          },
          "partnerName": {
            "type": "string"
          },
          "token": {
            "type": "string"
          },
          "authenticationApi": {
            "type": "string"
          },
          "accountingApi": {
            "type": "string"
          },
          "coaResponseApi": {
            "type": "string"
          },
          "coaApi": {
            "type": "string"
          },
          "sseTimeout": {
            "type": "integer"
          }
        }
      }
    }
  }
}

Retrieve List - All types of Accounting Service by query criteria

POST/v11_1/services/acct/query

Use this API command to retrieve a list of accounting services by query criteria. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6",
      "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "name": "CGF",
      "description": "",
      "protocol": "CGF",
      "type": "CGF",
      "createDateTime": 1486092683212,
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "admin",
      "modifiedDateTime": 1486095333155,
      "creatorUsername": "admin",
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    },
    {
      "id": "a7bb3550-e9c2-11e6-b761-64006a6a50c6",
      "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "name": "rad",
      "description": "",
      "protocol": "RADIUS",
      "type": "RADIUS",
      "createDateTime": 1486093292837,
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "admin",
      "modifiedDateTime": 1486093292837,
      "creatorUsername": "admin",
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for accounting servers",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the accounting service",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "name": {
            "description": "Name of the accounting service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the accounting service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "protocol": {
            "description": "Accounting protocol.",
            "type": "string",
            "enum": [
              "RADIUS",
              "CGF"
            ]
          },
          "type": {
            "description": "Accounting protocol same as protocol.",
            "type": "string",
            "enum": [
              "RADIUS",
              "CGF"
            ]
          },
          "tlsEnabled": {
            "type": "boolean"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Test specific Accounting Service

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

Use this API command to test an accounting service.

Request
HideShow
Body
{
  "id": "839f87c6-d116-497e-afce-aa8157abdasd",
  "loginRequest": {
    "password": "adsf",
    "userName": "test",
    "timeZoneUtcOffset": "+8",
    "protocol": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the authentication service",
      "type": "string"
    },
    "loginRequest": {
      "type": "object",
      "properties": {
        "password": {
          "description": "password for test user",
          "type": "string"
        },
        "userName": {
          "description": "name for test user",
          "type": "string"
        },
        "timeZoneUtcOffset": {
          "description": "timezone offset, ex: '+8'",
          "type": "string"
        },
        "protocol": {
          "type": "string"
        }
      }
    }
  }
}
Response  200

Retrieve List - Radius Accounting Service by query criteria

POST/v11_1/services/acct/radius/query

Use this API command to retrieve a list of Radius accounting services by query criteria. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "accountingServiceUUID",
      "mvnoId": "userMVNOId",
      "domainId": "userDomainId",
      "name": "accountingServiceName",
      "protocol": "RADIUS",
      "description": "accountingServiceDescription",
      "primary": {
        "ip": "192.168.1.1",
        "port": 1812,
        "sharedSecret": "sharedSecret"
      },
      "secondary": {
        "ip": "192.168.1.2",
        "port": 1812,
        "sharedSecret": "sharedSecret"
      },
      "healthCheckPolicy": {
        "responseWindow": 20,
        "reviveInterval": 120,
        "zombiePeriod": 40
      },
      "rateLimiting": {
        "maxOutstandingRequestsPerServer": 0,
        "threshold": 0,
        "sanityTimer": 10
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for radius accounting server",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the RADIUS accounting service",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "protocol": {
            "description": "Accounting protocol.",
            "type": "string",
            "enum": [
              "RADIUS"
            ]
          },
          "type": {
            "description": "Accounting protocol.",
            "type": "string",
            "enum": [
              "RADIUS"
            ]
          },
          "name": {
            "description": "Name of the RADIUS accounting service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the RADIUS accounting service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "primary": {
            "description": "Primary RADIUS server",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "type": "string"
              },
              "port": {
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "type": "string"
              },
              "ipFqdn": {
                "type": "string"
              }
            },
            "required": [
              "port",
              "ipFqdn"
            ]
          },
          "secondary": {
            "description": "Secondary RADIUS server",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "autoFallbackDisable": {
                "description": "Automatic fallback enabled or disabled",
                "type": "boolean"
              },
              "ip": {
                "description": "RADIUS server IP",
                "type": "string"
              },
              "port": {
                "description": "RADIUS server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535,
                "default": 1812
              },
              "sharedSecret": {
                "description": "RADIUS server shared secret",
                "type": "string"
              },
              "ipFqdn": {
                "description": "RADIUS server IP address or FQDN",
                "type": "string"
              }
            },
            "required": [
              "autoFallbackDisable",
              "port",
              "sharedSecret",
              "ipFqdn"
            ]
          },
          "healthCheckPolicy": {
            "description": "Health check policy",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "responseWindow": {
                "description": "Response window",
                "type": "integer",
                "minimum": 5,
                "maximum": 30,
                "default": 20
              },
              "reviveInterval": {
                "description": "Revive interval",
                "type": "integer",
                "minimum": 60,
                "maximum": 3600,
                "default": 120
              },
              "zombiePeriod": {
                "description": "Zombie period",
                "type": "integer",
                "minimum": 30,
                "maximum": 120,
                "default": 40
              },
              "responseFail": {
                "description": "Response Fail",
                "type": "boolean",
                "default": "false"
              }
            },
            "required": [
              "responseWindow",
              "reviveInterval",
              "zombiePeriod"
            ]
          },
          "rateLimiting": {
            "description": "Rate limiting",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "maxOutstandingRequestsPerServer": {
                "description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
                "type": "integer",
                "default": 0
              },
              "threshold": {
                "description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
                "type": "integer",
                "default": 0
              },
              "sanityTimer": {
                "description": "Sanity timer",
                "type": "integer",
                "minimum": 1,
                "maximum": 3600,
                "default": 10
              }
            },
            "required": [
              "maxOutstandingRequestsPerServer",
              "threshold",
              "sanityTimer"
            ]
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          },
          "tlsEnabled": {
            "type": "boolean"
          },
          "ocspUrl": {
            "type": "string",
            "maxLength": 1024
          },
          "cnSanIdentity": {
            "type": "string",
            "maxLength": 1023
          },
          "clientCertId": {
            "type": "string"
          },
          "serverCertId": {
            "type": "string"
          },
          "standbyTlsEnabled": {
            "type": "boolean"
          },
          "standbyOcspUrl": {
            "type": "string",
            "maxLength": 1024
          },
          "standbyCnSanIdentity": {
            "type": "string",
            "maxLength": 1023
          },
          "standbyClientCertId": {
            "type": "string"
          },
          "standbyServerCertId": {
            "type": "string"
          }
        }
      }
    }
  }
}

Create - RADIUS Accounting Service

POST/v11_1/services/acct/radius

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

Request
HideShow
Body
{
  "name": "accountingServiceName",
  "domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
  "primary": {
    "ip": "192.168.1.1",
    "port": 1813,
    "sharedSecret": "sharedSecret"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the RADIUS accounting service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "protocol": {
      "description": "Accounting protocol.",
      "type": "string",
      "enum": [
        "RADIUS"
      ]
    },
    "type": {
      "description": "Accounting protocol.",
      "type": "string",
      "enum": [
        "RADIUS"
      ]
    },
    "description": {
      "description": "Description of the RADIUS accounting service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "primary": {
      "description": "Primary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string"
        },
        "port": {
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "type": "string"
        },
        "ipFqdn": {
          "type": "string"
        }
      },
      "required": [
        "port",
        "ipFqdn"
      ]
    },
    "secondary": {
      "description": "Secondary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoFallbackDisable": {
          "description": "Automatic fallback enabled or disabled",
          "type": "boolean"
        },
        "ip": {
          "description": "RADIUS server IP",
          "type": "string"
        },
        "port": {
          "description": "RADIUS server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535,
          "default": 1812
        },
        "sharedSecret": {
          "description": "RADIUS server shared secret",
          "type": "string"
        },
        "ipFqdn": {
          "description": "RADIUS server IP address or FQDN",
          "type": "string"
        }
      },
      "required": [
        "autoFallbackDisable",
        "port",
        "sharedSecret",
        "ipFqdn"
      ]
    },
    "healthCheckPolicy": {
      "description": "Health check policy",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "responseWindow": {
          "description": "Response window",
          "type": "integer",
          "minimum": 5,
          "maximum": 30,
          "default": 20
        },
        "reviveInterval": {
          "description": "Revive interval",
          "type": "integer",
          "minimum": 60,
          "maximum": 3600,
          "default": 120
        },
        "zombiePeriod": {
          "description": "Zombie period",
          "type": "integer",
          "minimum": 30,
          "maximum": 120,
          "default": 40
        },
        "responseFail": {
          "description": "Response Fail",
          "type": "boolean",
          "default": "false"
        }
      },
      "required": [
        "responseWindow",
        "reviveInterval",
        "zombiePeriod"
      ]
    },
    "rateLimiting": {
      "description": "Rate limiting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "maxOutstandingRequestsPerServer": {
          "description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
          "type": "integer",
          "default": 0
        },
        "threshold": {
          "description": "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
          "type": "integer",
          "default": 0
        },
        "sanityTimer": {
          "description": "Sanity timer",
          "type": "integer",
          "minimum": 1,
          "maximum": 3600,
          "default": 10
        }
      },
      "required": [
        "maxOutstandingRequestsPerServer",
        "threshold",
        "sanityTimer"
      ]
    },
    "tlsEnabled": {
      "type": "boolean"
    },
    "ocspUrl": {
      "type": "string",
      "maxLength": 1024
    },
    "cnSanIdentity": {
      "type": "string",
      "maxLength": 1023
    },
    "clientCertId": {
      "type": "string"
    },
    "serverCertId": {
      "type": "string"
    },
    "standbyTlsEnabled": {
      "type": "boolean"
    },
    "standbyOcspUrl": {
      "type": "string",
      "maxLength": 1024
    },
    "standbyCnSanIdentity": {
      "type": "string",
      "maxLength": 1023
    },
    "standbyClientCertId": {
      "type": "string"
    },
    "standbyServerCertId": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "primary"
  ]
}
Response  201
HideShow
Body
{
  "id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Entire - RADIUS Accounting Service

PUT/v11_1/services/acct/radius/{id}

Use this API command to modify entire RADIUS accounting service.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "domainId": {
      "type": "string"
    },
    "protocol": {
      "description": "Accounting protocol.",
      "type": "string",
      "enum": [
        "RADIUS"
      ]
    },
    "type": {
      "description": "Accounting protocol.",
      "type": "string",
      "enum": [
        "RADIUS"
      ]
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "primary": {
      "description": "Primary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string"
        },
        "port": {
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "type": "string"
        },
        "ipFqdn": {
          "type": "string"
        }
      },
      "required": [
        "port",
        "ipFqdn"
      ]
    },
    "secondary": {
      "description": "Secondary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoFallbackDisable": {
          "description": "Automatic fallback enabled or disabled",
          "type": "boolean"
        },
        "ip": {
          "description": "RADIUS server IP",
          "type": "string"
        },
        "port": {
          "description": "RADIUS server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "RADIUS server shared secret",
          "type": "string"
        },
        "ipFqdn": {
          "description": "RADIUS server IP address or FQDN",
          "type": "string"
        }
      },
      "required": [
        "autoFallbackDisable",
        "port",
        "sharedSecret",
        "ipFqdn"
      ]
    },
    "healthCheckPolicy": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "responseWindow": {
          "description": "Response window",
          "type": "integer",
          "minimum": 5,
          "maximum": 30
        },
        "reviveInterval": {
          "description": "Revive interval",
          "type": "integer",
          "minimum": 60,
          "maximum": 3600
        },
        "zombiePeriod": {
          "description": "Zombie period",
          "type": "integer",
          "minimum": 30,
          "maximum": 120
        },
        "responseFail": {
          "description": "Response Fail",
          "type": "boolean"
        }
      },
      "required": [
        "responseWindow",
        "reviveInterval",
        "zombiePeriod"
      ]
    },
    "rateLimiting": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "maxOutstandingRequestsPerServer": {
          "description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
          "type": "integer"
        },
        "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"
        },
        "sanityTimer": {
          "description": "Sanity timer",
          "type": "integer",
          "minimum": 1,
          "maximum": 3600
        }
      },
      "required": [
        "maxOutstandingRequestsPerServer",
        "threshold",
        "sanityTimer"
      ]
    },
    "tlsEnabled": {
      "type": "boolean"
    },
    "ocspUrl": {
      "type": "string",
      "maxLength": 1024
    },
    "cnSanIdentity": {
      "type": "string",
      "maxLength": 1023
    },
    "clientCertId": {
      "type": "string"
    },
    "serverCertId": {
      "type": "string"
    },
    "standbyTlsEnabled": {
      "type": "boolean"
    },
    "standbyOcspUrl": {
      "type": "string",
      "maxLength": 1024
    },
    "standbyCnSanIdentity": {
      "type": "string",
      "maxLength": 1023
    },
    "standbyClientCertId": {
      "type": "string"
    },
    "standbyServerCertId": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "type",
    "primary",
    "rateLimiting"
  ]
}
Response  204

Modify - RADIUS Accounting Service

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

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

Request
HideShow
Body
{
  "name": "new name",
  "description": "new description",
  "primary": {
    "ip": "192.168.1.1",
    "port": 1812,
    "sharedSecret": "sharedSecret"
  },
  "secondary": {
    "autoFallbackDisable": false,
    "ip": "192.168.1.2",
    "port": 1812,
    "sharedSecret": "sharedSecret"
  },
  "healthCheckPolicy": {
    "responseWindow": 20,
    "reviveInterval": 120,
    "zombiePeriod": 40
  },
  "rateLimiting": {
    "maxOutstandingRequestsPerServer": 0,
    "threshold": 0,
    "sanityTimer": 10
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the RADIUS accounting service",
      "type": "string"
    },
    "name": {
      "description": "Name of the RADIUS accounting service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "protocol": {
      "description": "Accounting protocol.",
      "type": "string",
      "enum": [
        "RADIUS"
      ]
    },
    "type": {
      "description": "Accounting protocol.",
      "type": "string",
      "enum": [
        "RADIUS"
      ]
    },
    "description": {
      "description": "Description of the RADIUS accounting service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "primary": {
      "description": "Primary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "type": "string"
        },
        "port": {
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "type": "string"
        },
        "ipFqdn": {
          "type": "string"
        }
      },
      "required": [
        "port",
        "ipFqdn"
      ]
    },
    "secondary": {
      "description": "Secondary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoFallbackDisable": {
          "description": "Automatic fallback enabled or disabled",
          "type": "boolean"
        },
        "ip": {
          "description": "RADIUS server IP",
          "type": "string"
        },
        "port": {
          "description": "RADIUS server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "RADIUS server shared secret",
          "type": "string"
        },
        "ipFqdn": {
          "description": "RADIUS server IP address or FQDN",
          "type": "string"
        }
      },
      "required": [
        "autoFallbackDisable",
        "port",
        "sharedSecret",
        "ipFqdn"
      ]
    },
    "healthCheckPolicy": {
      "description": "Health check policy",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "responseWindow": {
          "description": "Response window",
          "type": "integer",
          "minimum": 5,
          "maximum": 30
        },
        "reviveInterval": {
          "description": "Revive interval",
          "type": "integer",
          "minimum": 60,
          "maximum": 3600
        },
        "zombiePeriod": {
          "description": "Zombie period",
          "type": "integer",
          "minimum": 30,
          "maximum": 120
        },
        "responseFail": {
          "description": "Response Fail",
          "type": "boolean"
        }
      },
      "required": [
        "responseWindow",
        "reviveInterval",
        "zombiePeriod"
      ]
    },
    "rateLimiting": {
      "description": "Rate limiting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "maxOutstandingRequestsPerServer": {
          "description": "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
          "type": "integer"
        },
        "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"
        },
        "sanityTimer": {
          "description": "Sanity timer",
          "type": "integer",
          "minimum": 1,
          "maximum": 3600
        }
      },
      "required": [
        "maxOutstandingRequestsPerServer",
        "threshold",
        "sanityTimer"
      ]
    },
    "tlsEnabled": {
      "type": "boolean"
    },
    "ocspUrl": {
      "type": "string",
      "maxLength": 1024
    },
    "cnSanIdentity": {
      "type": "string",
      "maxLength": 1023
    },
    "clientCertId": {
      "type": "string"
    },
    "serverCertId": {
      "type": "string"
    },
    "standbyTlsEnabled": {
      "type": "boolean"
    },
    "standbyOcspUrl": {
      "type": "string",
      "maxLength": 1024
    },
    "standbyCnSanIdentity": {
      "type": "string",
      "maxLength": 1023
    },
    "standbyClientCertId": {
      "type": "string"
    },
    "standbyServerCertId": {
      "type": "string"
    }
  }
}
Response  204

Delete Accounting Service

DELETE/v11_1/services/acct/{id}

Use this API command to delete an accounting service.

Response  204

Delete a list of Accounting Service

DELETE/v11_1/services/acct

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

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

Delete - RADIUS Accounting Service

DELETE/v11_1/services/acct/radius/{id}

Use this API command to delete a RADIUS accounting service.

Response  204

Disable Secondary RADIUS Server of Accounting Service

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

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

Response  204

L2 Access Control in Domain Level

Retrieve List

GET/v11_1/l2AccessControls

Use this API command to retrieve a list of L2 Access Control.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

domainId
string (optional) 

Domain id for query

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "name": "l2acl_1_name",
      "id": "128a26b0-ab73-11e4-87f2-000c29c1611c",
      "description": "l2acl_1_desc",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "restriction": "ALLOW",
      "rules": [
        {
          "mac": "33:11:11:11:11:12"
        },
        {
          "mac": "22:11:11:11:11:11"
        }
      ],
      "etherTypeRestriction": "ALLOW",
      "etherTypes": [
        {
          "etherType": "0x0806"
        },
        {
          "etherType": "0x22EA"
        },
        {
          "etherType": "0x22F3"
        }
      ],
      "modifierUsername": "admin",
      "modifiedDateTime": 1557222184811,
      "createDateTime": 1557211993209,
      "creatorUsername": "admin",
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    },
    {
      "name": "l2acl_2_name",
      "id": "228a26b0-ab73-11e4-87f2-000c29c1611c",
      "description": "l2acl_2_desc",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "restriction": "ALLOW",
      "rules": [
        {
          "mac": "33:11:11:11:11:12"
        },
        {
          "mac": "22:11:11:11:11:11"
        }
      ],
      "etherTypeRestriction": "ALLOW",
      "etherTypes": [
        {
          "etherType": "0x0806"
        },
        {
          "etherType": "0x22EA"
        },
        {
          "etherType": "0x22F3"
        }
      ],
      "modifierUsername": "admin",
      "modifiedDateTime": 1557222184811,
      "createDateTime": 1557211993209,
      "creatorUsername": "admin",
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    }
  ],
  "extra": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "Extra information for l2 Access Control profile.",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "identifier of the L2 Access Control",
            "type": "string"
          },
          "name": {
            "description": "name of the L2 Access Control",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "description of the L2 Access Control",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "domainId": {
            "type": "string"
          },
          "restriction": {
            "description": "restriction of mac rule of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
            "type": "string",
            "enum": [
              "ALLOW",
              "BLOCK"
            ]
          },
          "rules": {
            "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])$"
                }
              },
              "required": [
                "mac"
              ]
            }
          },
          "etherTypeRestriction": {
            "description": "restriction of EtherType rule of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
            "type": "string",
            "enum": [
              "ALLOW",
              "BLOCK"
            ]
          },
          "etherTypes": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "etherType": {
                  "type": "string",
                  "enum": [
                    "0x0800",
                    "0x86DD",
                    "0x0806",
                    "0x8808",
                    "0x8809",
                    "0x8863",
                    "0x8864",
                    "0x888E",
                    "0x88CC"
                  ]
                }
              }
            }
          },
          "userDefinedEtherTypes": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "etherType": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 6
                },
                "protocolName": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 32
                }
              },
              "required": [
                "etherType",
                "protocolName"
              ]
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer",
            "format": "int64"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer",
            "format": "int64"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier name",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve

GET/v11_1/l2AccessControls/{id}

Use this API command to retrieve an L2 Access Control.

Response  200
HideShow
Body
{
  "name": "l2acl_name",
  "id": "128a26b0-ab73-11e4-87f2-000c29c1611c",
  "description": "l2acl_desc",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "restriction": "ALLOW",
  "rules": [
    {
      "mac": "33:11:11:11:11:12"
    },
    {
      "mac": "22:11:11:11:11:11"
    }
  ],
  "etherTypeRestriction": "ALLOW",
  "etherTypes": [
    {
      "etherType": "0x0806"
    },
    {
      "etherType": "0x22EA"
    },
    {
      "etherType": "0x22F3"
    }
  ],
  "modifierUsername": "admin",
  "modifiedDateTime": 1557222184811,
  "createDateTime": 1557211993209,
  "creatorUsername": "admin",
  "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "identifier of the L2 Access Control",
      "type": "string"
    },
    "name": {
      "description": "name of the L2 Access Control",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the L2 Access Control",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "domainId": {
      "type": "string"
    },
    "restriction": {
      "description": "restriction of mac rule of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    },
    "rules": {
      "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])$"
          }
        },
        "required": [
          "mac"
        ]
      }
    },
    "etherTypeRestriction": {
      "description": "restriction of EtherType rule of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    },
    "etherTypes": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "etherType": {
            "type": "string",
            "enum": [
              "0x0800",
              "0x86DD",
              "0x0806",
              "0x8808",
              "0x8809",
              "0x8863",
              "0x8864",
              "0x888E",
              "0x88CC"
            ]
          }
        }
      }
    },
    "userDefinedEtherTypes": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "etherType": {
            "type": "string",
            "minLength": 1,
            "maxLength": 6
          },
          "protocolName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 32
          }
        },
        "required": [
          "etherType",
          "protocolName"
        ]
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer",
      "format": "int64"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer",
      "format": "int64"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier name",
      "type": "string"
    }
  }
}

Retrieve L2 Access Control List

POST/v11_1/l2AccessControls/query

Query L2 Access Control with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "name": "l2acl_1_name",
      "id": "128a26b0-ab73-11e4-87f2-000c29c1611c",
      "description": "l2acl_1_desc",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "restriction": "ALLOW",
      "rules": [
        {
          "mac": "33:11:11:11:11:12"
        },
        {
          "mac": "22:11:11:11:11:11"
        }
      ],
      "etherTypeRestriction": "ALLOW",
      "etherTypes": [
        {
          "etherType": "0x0806"
        },
        {
          "etherType": "0x22EA"
        },
        {
          "etherType": "0x22F3"
        }
      ],
      "modifierUsername": "admin",
      "modifiedDateTime": 1557222184811,
      "createDateTime": 1557211993209,
      "creatorUsername": "admin",
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    },
    {
      "name": "l2acl_2_name",
      "id": "228a26b0-ab73-11e4-87f2-000c29c1611c",
      "description": "l2acl_2_desc",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "restriction": "ALLOW",
      "rules": [
        {
          "mac": "33:11:11:11:11:12"
        },
        {
          "mac": "22:11:11:11:11:11"
        }
      ],
      "etherTypeRestriction": "ALLOW",
      "etherTypes": [
        {
          "etherType": "0x0806"
        },
        {
          "etherType": "0x22EA"
        },
        {
          "etherType": "0x22F3"
        }
      ],
      "modifierUsername": "admin",
      "modifiedDateTime": 1557222184811,
      "createDateTime": 1557211993209,
      "creatorUsername": "admin",
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    }
  ],
  "extra": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "Extra information for l2 Access Control profile.",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "identifier of the L2 Access Control",
            "type": "string"
          },
          "name": {
            "description": "name of the L2 Access Control",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "description of the L2 Access Control",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "domainId": {
            "type": "string"
          },
          "restriction": {
            "description": "restriction of mac rule of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
            "type": "string",
            "enum": [
              "ALLOW",
              "BLOCK"
            ]
          },
          "rules": {
            "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])$"
                }
              },
              "required": [
                "mac"
              ]
            }
          },
          "etherTypeRestriction": {
            "description": "restriction of EtherType rule of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
            "type": "string",
            "enum": [
              "ALLOW",
              "BLOCK"
            ]
          },
          "etherTypes": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "etherType": {
                  "type": "string",
                  "enum": [
                    "0x0800",
                    "0x86DD",
                    "0x0806",
                    "0x8808",
                    "0x8809",
                    "0x8863",
                    "0x8864",
                    "0x888E",
                    "0x88CC"
                  ]
                }
              }
            }
          },
          "userDefinedEtherTypes": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "etherType": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 6
                },
                "protocolName": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 32
                }
              },
              "required": [
                "etherType",
                "protocolName"
              ]
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer",
            "format": "int64"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer",
            "format": "int64"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier name",
            "type": "string"
          }
        }
      }
    }
  }
}

Create

POST/v11_1/l2AccessControls

Use this API command to create a new L2 Access Control.

Request
HideShow
Body
{
  "name": "l2acl_create_name",
  "description": "l2acl_create_desc",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "restriction": "ALLOW",
  "rules": [
    {
      "mac": "33:11:11:11:11:12"
    },
    {
      "mac": "22:11:11:11:11:11"
    }
  ],
  "etherTypeRestriction": "ALLOW",
  "etherTypes": [
    {
      "etherType": "0x0806"
    },
    {
      "etherType": "0x22EA"
    },
    {
      "etherType": "0x9100"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "name of the L2 Access Control",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the L2 Access Control",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "domainId": {
      "type": "string"
    },
    "restriction": {
      "description": "restriction of mac rule of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    },
    "rules": {
      "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])$"
          }
        },
        "required": [
          "mac"
        ]
      }
    },
    "etherTypeRestriction": {
      "description": "restriction of EtherType rule of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    },
    "etherTypes": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "etherType": {
            "type": "string",
            "enum": [
              "0x0800",
              "0x86DD",
              "0x0806",
              "0x8808",
              "0x8809",
              "0x8863",
              "0x8864",
              "0x888E",
              "0x88CC"
            ]
          }
        }
      }
    },
    "userDefinedEtherTypes": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "etherType": {
            "type": "string",
            "minLength": 1,
            "maxLength": 6
          },
          "protocolName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 32
          }
        },
        "required": [
          "etherType",
          "protocolName"
        ]
      }
    }
  },
  "required": [
    "name",
    "restriction",
    "etherTypeRestriction"
  ]
}
Response  201
HideShow
Body
{
  "id": "05f0503b-cfd9-414e-b37d-72a96f0f4288"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PUT/v11_1/l2AccessControls/{id}

Use this API command to modify a specific L2 Access Control.

Request
HideShow
Body
{
  "name": "l2acl_modify_name",
  "description": "l2acl_modify_desc",
  "restriction": "BLOCK",
  "rules": [
    {
      "mac": "33:11:11:11:11:12"
    },
    {
      "mac": "22:11:11:11:11:11"
    }
  ],
  "etherTypeRestriction": "ALLOW",
  "etherTypes": [
    {
      "etherType": "0x0806"
    },
    {
      "etherType": "0x22EA"
    },
    {
      "etherType": "0x9100"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "name of the L2 Access Control",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the L2 Access Control",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "restriction": {
      "description": "restriction of mac rule of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    },
    "rules": {
      "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])$"
          }
        },
        "required": [
          "mac"
        ]
      }
    },
    "etherTypeRestriction": {
      "description": "restriction of EtherType rule of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK"
      ]
    },
    "etherTypes": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "etherType": {
            "type": "string",
            "enum": [
              "0x0800",
              "0x86DD",
              "0x0806",
              "0x8808",
              "0x8809",
              "0x8863",
              "0x8864",
              "0x888E",
              "0x88CC"
            ]
          }
        }
      }
    },
    "userDefinedEtherTypes": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "etherType": {
            "type": "string",
            "minLength": 1,
            "maxLength": 6
          },
          "protocolName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 32
          }
        },
        "required": [
          "etherType",
          "protocolName"
        ]
      }
    }
  },
  "required": [
    "restriction",
    "etherTypeRestriction"
  ]
}
Response  204

Delete

DELETE/v11_1/l2AccessControls/{id}

Use this API command to delete an L2 Access Control.

Response  204

Bulk Delete

DELETE/v11_1/l2AccessControls

Use this API command to delete a list of L2 Access Control.

Request
HideShow
Body
{
  "idList": [
    "eac50e51-4a63-11e7-a68a-0a0027000000",
    "1b4950d1-49d9-11e7-a68a-0a0027000000"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

User Traffic Profile

Retrieve List - User Traffic Profile

GET/v11_1/profiles/utp

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

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "267ef3a0-738b-11e4-96d5-0a7820524153",
      "name": "new name"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for profile",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the profile",
            "type": "string"
          },
          "name": {
            "description": "Name of the profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          }
        }
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Retrieve - User Traffic Profile

GET/v11_1/profiles/utp/{id}

Use this API command to retrieve an user traffic profile.

Response  200
HideShow
Body
{
  "id": "1869c000-9c5e-11e4-9d3a-00606eb0c700",
  "name": "user-traffic-profile-name",
  "description": "user traffic profile description",
  "defaultAction": "ALLOW",
  "ipAclRules": [
    {
      "priority": 1,
      "description": "Allow DNS",
      "uplinkRateLimiting": {
        "uplinkRateLimitingEnabled": true,
        "uplinkRateLimitingBps": "0.50"
      },
      "downlinkRateLimiting": {
        "downlinkRateLimitingEnabled": true,
        "downlinkRateLimitingBps": "0.50"
      },
      "enableSourceIpSubnet": true,
      "sourceIp": "172.17.26.50",
      "sourceIpMask": "255.255.0.0",
      "enableDestinationIpSubnet": true,
      "destinationIp": "172.17.29.31",
      "destinationIpMask": "255.255.255.0",
      "enableSourcePortRange": true,
      "sourceMinPort": 10,
      "sourceMaxPort": 65530,
      "enableDestinationPortRange": false,
      "destinationMinPort": 53,
      "destinationMaxPort": null,
      "protocol": null,
      "action": "ALLOW",
      "direction": "UPSTREAM"
    },
    {
      "priority": 2,
      "description": "Allow DHCP",
      "enableSourceIpSubnet": false,
      "sourceIp": "172.17.51.99",
      "sourceIpMask": "",
      "enableDestinationIpSubnet": false,
      "destinationIp": "172.17.53.99",
      "destinationIpMask": "",
      "enableSourcePortRange": true,
      "sourceMinPort": null,
      "sourceMaxPort": null,
      "enableDestinationPortRange": false,
      "destinationMinPort": 67,
      "destinationMaxPort": null,
      "protocol": null,
      "action": "ALLOW",
      "direction": "UPSTREAM"
    }
  ],
  "uplinkRateLimiting": {
    "uplinkRateLimitingEnabled": true,
    "uplinkRateLimitingBps": "2.75 mbps"
  },
  "downlinkRateLimiting": {
    "downlinkRateLimitingEnabled": true,
    "downlinkRateLimitingBps": "2.00 mbps"
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the user traffic profile",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the user traffic profile",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the user traffic profile",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "defaultAction" : {
            "description" : "Default action",
            "default" : "ALLOW",
            "type" : "string",
            "enum" : [ "BLOCK", "ALLOW" ]
        },
        "uplinkRateLimiting" : {
            "description" : "Uplink rate limiting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "uplinkRateLimitingEnabled" : {
                    "description" : "Uplink rate limiting enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRateLimitingBps" : {
                    "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
                    "type" : "string",
                    "pattern" : "\S+ mbps$"
                }
            }
        },
        "downlinkRateLimiting" : {
            "description" : "Downlink rate limiting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "downlinkRateLimitingEnabled" : {
                    "description" : "Downlink rate limiting enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRateLimitingBps" : {
                    "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
                    "type" : "string",
                    "pattern" : "\S+ mbps$"
                }
            }
        },
        "ipAclRules" : {
            "type" : "array",
            "description" : "Traffic access control list",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "priority" : {
                        "type" : "integer",
                        "description" : "Priority"
                    },
                    "description" : {
                        "description" : "Description of the traffic access control rule",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64
                    },
                    "uplinkRateLimitingEnabled" : {
                        "description" : "Uplink rate limiting enabled",
                        "type" : "boolean"
                    },
                    "uplinkRateLimitingMbps" : {
                        "description" : "Uplink rate limiting",
                        "type" : "number"
                    },
                    "downlinkRateLimitingEnabled" : {
                        "description" : "Downlink rate limiting enabled",
                        "type" : "boolean"
                    },
                    "downlinkRateLimitingMbps" : {
                        "description" : "Downlink rate limiting",
                        "type" : "number"
                    },
                    "ipType" : {
                        "description" : "IP Type(IPv4 or IPv6).",
                        "default" : "IPv4",
                        "type" : "string",
                        "enum" : [ "IPv4", "IPv6" ]
                    },
                    "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"
                    },
                    "enableSourceV6Prefix" : {
                        "description" : "Enable Source IPv6 prefix.",
                        "type" : "boolean"
                    },
                    "sourceIpV6" : {
                        "type" : "string",
                        "description" : "Source IPv6 Address."
                    },
                    "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"
                    },
                    "enableDestinationV6Prefix" : {
                        "description" : "Enable Destination IPv6 prefix.",
                        "type" : "boolean"
                    },
                    "destinationIpV6" : {
                        "type" : "string",
                        "description" : "Destination IPv6 Address."
                    },
                    "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.",
                        "type" : "string",
                        "enum" : [ "TCP", "UDP", "UDPLITE", "ICMP_ICMPV4", "ICMPV6", "IGMP", "ESP", "AH", "SCTP", "CUSTOM" ]
                    },
                    "customProtocol" : {
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 255,
                        "description" : "The protocol of traffic access control. Available if the protocol is set to CUSTOM."
                    },
                    "action" : {
                        "description" : "The access of traffic access control.",
                        "default" : "ALLOW",
                        "type" : "string",
                        "enum" : [ "ALLOW", "BLOCK" ]
                    },
                    "direction" : {
                        "description" : "The direction of traffic access control.",
                        "default" : "UPSTREAM",
                        "type" : "string",
                        "enum" : [ "UPSTREAM" ]
                    }
                }
            }
        },
        "appPolicyId" : {
            "description" : "Application Policy UUID (for 5.0 and Earlier Firmware Versions)",
            "type" : "string"
        },
        "qmAppPolicyId" : {
            "description" : "Application Policy UUID",
            "type" : "string"
        },
        "urlFilteringPolicyId" : {
            "description" : "URL Filtering Policy UUID",
            "type" : "string"
        },
        "mvnoId" : {
            "description" : "Tenant UUID",
            "type" : "string"
        },
        "domainId" : {
            "description" : "Domain UUID",
            "type" : "string"
        },
        "isFactoryDefault" : {
            "description" : "Whether the UTP is factory default or not",
            "type" : "boolean"
        },
        "createDateTime" : {
            "description" : "Timestamp of being created",
            "type" : "integer"
        },
        "modifiedDateTime" : {
            "description" : "Timestamp of being modified",
            "type" : "integer"
        },
        "creatorId" : {
            "description" : "Creator ID",
            "type" : "string"
        },
        "modifierId" : {
            "description" : "Modifier ID",
            "type" : "string"
        },
        "creatorUsername" : {
            "description" : "Creator Name",
            "type" : "string"
        },
        "modifierUsername" : {
            "description" : "Modifier Name",
            "type" : "string"
        }
    }
}

Retrieve List - User Traffic Profile by query criteria

POST/v11_1/profiles/utp/query

Use this API command to retrieve a list of User Traffic Profile by query criteria. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "f79b7400-dd6e-11e6-8486-64006a6a50c6",
      "name": "123",
      "description": "",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "defaultAction": "ALLOW",
      "appPolicyId": "",
      "qmAppPolicyId": "",
      "urlFilteringPolicyId": "",
      "ipAclRules": [
        {
          "priority": 1,
          "uplinkRateLimitingEnabled": null,
          "downlinkRateLimitingEnabled": null,
          "uplinkRateLimitingMbps": null,
          "downlinkRateLimitingMbps": null,
          "description": "Allow DNS",
          "enableSourceIpSubnet": false,
          "sourceIp": null,
          "sourceIpMask": null,
          "enableDestinationIpSubnet": false,
          "destinationIp": null,
          "destinationIpMask": null,
          "enableSourcePortRange": true,
          "sourceMinPort": null,
          "sourceMaxPort": null,
          "enableDestinationPortRange": false,
          "destinationMinPort": 53,
          "destinationMaxPort": null,
          "protocol": null,
          "action": "ALLOW",
          "direction": "UPSTREAM"
        },
        {
          "priority": 2,
          "uplinkRateLimitingEnabled": null,
          "downlinkRateLimitingEnabled": null,
          "uplinkRateLimitingMbps": null,
          "downlinkRateLimitingMbps": null,
          "description": "Allow DHCP",
          "enableSourceIpSubnet": false,
          "sourceIp": null,
          "sourceIpMask": null,
          "enableDestinationIpSubnet": false,
          "destinationIp": null,
          "destinationIpMask": null,
          "enableSourcePortRange": true,
          "sourceMinPort": null,
          "sourceMaxPort": null,
          "enableDestinationPortRange": false,
          "destinationMinPort": 67,
          "destinationMaxPort": null,
          "protocol": null,
          "action": "ALLOW",
          "direction": "UPSTREAM"
        }
      ],
      "uplinkRateLimiting": {
        "uplinkRateLimitingEnabled": false,
        "uplinkRateLimitingBps": null
      },
      "downlinkRateLimiting": {
        "downlinkRateLimitingEnabled": false,
        "downlinkRateLimitingBps": null
      },
      "isFactoryDefault": false,
      "createDateTime": 1484737935168,
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "admin",
      "modifiedDateTime": 1484737935168,
      "creatorUsername": "admin",
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    },
    {
      "id": "86b77cc1-dd46-11e6-bfbb-64006a6a50c6",
      "name": "System Default",
      "description": "System default traffic profile allows all traffic",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "defaultAction": "ALLOW",
      "appPolicyId": "",
      "qmAppPolicyId": "",
      "urlFilteringPolicyId": "",
      "ipAclRules": [],
      "uplinkRateLimiting": null,
      "downlinkRateLimiting": null,
      "isFactoryDefault": true,
      "createDateTime": 1484720565900,
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "admin",
      "modifiedDateTime": 1484720565901,
      "creatorUsername": "admin",
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    }
  ],
  "extra": {}
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "type" : "integer"
        },
        "hasMore" : {
            "type" : "boolean"
        },
        "firstIndex" : {
            "type" : "integer"
        },
        "extra" : {
            "description" : "extra information for User Traffic profile",
            "type" : "object",
            "properties" : {
                "rbacMetadata" : {
                    "type" : "array",
                    "items" : {
                        "additionalProperties" : {
                            "type" : "string"
                        },
                        "properties" : { }
                    }
                }
            }
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Identifier of the user traffic profile",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the user traffic profile",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                    },
                    "description" : {
                        "description" : "Description of the user traffic profile",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64
                    },
                    "defaultAction" : {
                        "description" : "Default action",
                        "default" : "ALLOW",
                        "type" : "string",
                        "enum" : [ "BLOCK", "ALLOW" ]
                    },
                    "uplinkRateLimiting" : {
                        "description" : "Uplink rate limiting",
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "uplinkRateLimitingEnabled" : {
                                "description" : "Uplink rate limiting enabled or disabled",
                                "type" : "boolean",
                                "default" : false
                            },
                            "uplinkRateLimitingBps" : {
                                "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
                                "type" : "string",
                                "pattern" : "\S+ mbps$"
                            }
                        }
                    },
                    "downlinkRateLimiting" : {
                        "description" : "Downlink rate limiting",
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "downlinkRateLimitingEnabled" : {
                                "description" : "Downlink rate limiting enabled or disabled",
                                "type" : "boolean",
                                "default" : false
                            },
                            "downlinkRateLimitingBps" : {
                                "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
                                "type" : "string",
                                "pattern" : "\S+ mbps$"
                            }
                        }
                    },
                    "ipAclRules" : {
                        "type" : "array",
                        "description" : "Traffic access control list",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "priority" : {
                                    "type" : "integer",
                                    "description" : "Priority"
                                },
                                "description" : {
                                    "description" : "Description of the traffic access control rule",
                                    "type" : [ "string", "null" ],
                                    "maxLength" : 64
                                },
                                "uplinkRateLimitingEnabled" : {
                                    "description" : "Uplink rate limiting enabled",
                                    "type" : "boolean"
                                },
                                "uplinkRateLimitingMbps" : {
                                    "description" : "Uplink rate limiting",
                                    "type" : "number"
                                },
                                "downlinkRateLimitingEnabled" : {
                                    "description" : "Downlink rate limiting enabled",
                                    "type" : "boolean"
                                },
                                "downlinkRateLimitingMbps" : {
                                    "description" : "Downlink rate limiting",
                                    "type" : "number"
                                },
                                "ipType" : {
                                    "description" : "IP Type(IPv4 or IPv6).",
                                    "default" : "IPv4",
                                    "type" : "string",
                                    "enum" : [ "IPv4", "IPv6" ]
                                },
                                "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"
                                },
                                "enableSourceV6Prefix" : {
                                    "description" : "Enable Source IPv6 prefix.",
                                    "type" : "boolean"
                                },
                                "sourceIpV6" : {
                                    "type" : "string",
                                    "description" : "Source IPv6 Address."
                                },
                                "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"
                                },
                                "enableDestinationV6Prefix" : {
                                    "description" : "Enable Destination IPv6 prefix.",
                                    "type" : "boolean"
                                },
                                "destinationIpV6" : {
                                    "type" : "string",
                                    "description" : "Destination IPv6 Address."
                                },
                                "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.",
                                    "type" : "string",
                                    "enum" : [ "TCP", "UDP", "UDPLITE", "ICMP_ICMPV4", "ICMPV6", "IGMP", "ESP", "AH", "SCTP", "CUSTOM" ]
                                },
                                "customProtocol" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 255,
                                    "description" : "The protocol of traffic access control. Available if the protocol is set to CUSTOM."
                                },
                                "action" : {
                                    "description" : "The access of traffic access control.",
                                    "default" : "ALLOW",
                                    "type" : "string",
                                    "enum" : [ "ALLOW", "BLOCK" ]
                                },
                                "direction" : {
                                    "description" : "The direction of traffic access control.",
                                    "default" : "UPSTREAM",
                                    "type" : "string",
                                    "enum" : [ "UPSTREAM" ]
                                }
                            }
                        }
                    },
                    "appPolicyId" : {
                        "description" : "Application Policy UUID (for 5.0 and Earlier Firmware Versions)",
                        "type" : "string"
                    },
                    "qmAppPolicyId" : {
                        "description" : "Application Policy UUID",
                        "type" : "string"
                    },
                    "urlFilteringPolicyId" : {
                        "description" : "URL Filtering Policy UUID",
                        "type" : "string"
                    },
                    "mvnoId" : {
                        "description" : "Tenant UUID",
                        "type" : "string"
                    },
                    "domainId" : {
                        "description" : "Domain UUID",
                        "type" : "string"
                    },
                    "isFactoryDefault" : {
                        "description" : "Whether the UTP is factory default or not",
                        "type" : "boolean"
                    },
                    "createDateTime" : {
                        "description" : "Timestamp of being created",
                        "type" : "integer"
                    },
                    "modifiedDateTime" : {
                        "description" : "Timestamp of being modified",
                        "type" : "integer"
                    },
                    "creatorId" : {
                        "description" : "Creator ID",
                        "type" : "string"
                    },
                    "modifierId" : {
                        "description" : "Modifier ID",
                        "type" : "string"
                    },
                    "creatorUsername" : {
                        "description" : "Creator Name",
                        "type" : "string"
                    },
                    "modifierUsername" : {
                        "description" : "Modifier Name",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

Create - User Traffic Profile

POST/v11_1/profiles/utp

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

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "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"
  },
  "ipAclRules": [
    {
      "priority": 1,
      "description": "Allow DNS",
      "ipType": "IPv6",
      "enableSourceV6Prefix": true,
      "sourceIpV6": "",
      "action": "ALLOW",
      "direction": "UPSTREAM"
    }
  ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the user traffic profile",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the user traffic profile",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "defaultAction" : {
            "description" : "Default action",
            "default" : "ALLOW",
            "type" : "string",
            "enum" : [ "BLOCK", "ALLOW" ]
        },
        "uplinkRateLimiting" : {
            "description" : "Uplink rate limiting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "uplinkRateLimitingEnabled" : {
                    "description" : "Uplink rate limiting enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "uplinkRateLimitingBps" : {
                    "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
                    "type" : "string",
                    "pattern" : "\S+ mbps$"
                }
            }
        },
        "downlinkRateLimiting" : {
            "description" : "Downlink rate limiting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "downlinkRateLimitingEnabled" : {
                    "description" : "Downlink rate limiting enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "downlinkRateLimitingBps" : {
                    "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
                    "type" : "string",
                    "pattern" : "\S+ mbps$"
                }
            }
        },
        "ipAclRules" : {
            "type" : "array",
            "description" : "Traffic access control list",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "priority" : {
                        "type" : "integer",
                        "description" : "Priority"
                    },
                    "description" : {
                        "description" : "Description of the traffic access control rule",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64
                    },
                    "uplinkRateLimitingEnabled" : {
                        "description" : "Uplink rate limiting enabled",
                        "type" : "boolean"
                    },
                    "uplinkRateLimitingMbps" : {
                        "description" : "Uplink rate limiting",
                        "type" : "number"
                    },
                    "downlinkRateLimitingEnabled" : {
                        "description" : "Downlink rate limiting enabled",
                        "type" : "boolean"
                    },
                    "downlinkRateLimitingMbps" : {
                        "description" : "Downlink rate limiting",
                        "type" : "number"
                    },
                    "ipType" : {
                        "description" : "IP Type(IPv4 or IPv6).",
                        "default" : "IPv4",
                        "type" : "string",
                        "enum" : [ "IPv4", "IPv6" ]
                    },
                    "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"
                    },
                    "enableSourceV6Prefix" : {
                        "description" : "Enable Source IPv6 prefix.",
                        "type" : "boolean"
                    },
                    "sourceIpV6" : {
                        "type" : "string",
                        "description" : "Source IPv6 Address."
                    },
                    "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"
                    },
                    "enableDestinationV6Prefix" : {
                        "description" : "Enable Destination IPv6 prefix.",
                        "type" : "boolean"
                    },
                    "destinationIpV6" : {
                        "type" : "string",
                        "description" : "Destination IPv6 Address."
                    },
                    "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.",
                        "type" : "string",
                        "enum" : [ "TCP", "UDP", "UDPLITE", "ICMP_ICMPV4", "ICMPV6", "IGMP", "ESP", "AH", "SCTP", "CUSTOM" ]
                    },
                    "customProtocol" : {
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 255,
                        "description" : "The protocol of traffic access control. Available if the protocol is set to CUSTOM."
                    },
                    "action" : {
                        "description" : "The access of traffic access control.",
                        "default" : "ALLOW",
                        "type" : "string",
                        "enum" : [ "ALLOW", "BLOCK" ]
                    },
                    "direction" : {
                        "description" : "The direction of traffic access control.",
                        "default" : "UPSTREAM",
                        "type" : "string",
                        "enum" : [ "UPSTREAM" ]
                    }
                }
            }
        },
        "appPolicyId" : {
            "description" : "Application Policy UUID (for 5.0 and Earlier Firmware Versions)",
            "type" : "string"
        },
        "qmAppPolicyId" : {
            "description" : "Application Policy UUID",
            "type" : "string"
        },
        "urlFilteringPolicyId" : {
            "description" : "URL Filtering Policy UUID",
            "type" : "string"
        },
        "mvnoId" : {
            "description" : "Tenant UUID",
            "type" : "string"
        },
        "domainId" : {
            "description" : "Domain UUID",
            "type" : "string"
        }
    },
    "required" : [ "name", "defaultAction" ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Clone

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

Use this API command to copy a traffic profile.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "oldName": {
      "description": "original name",
      "type": "string"
    },
    "oldId": {
      "description": "original name",
      "type": "string"
    },
    "newName": {
      "description": "Id for new profile",
      "type": "string"
    },
    "newId": {
      "description": "name for new profile",
      "type": "string"
    }
  }
}
Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "oldName": {
      "description": "original name",
      "type": "string"
    },
    "oldId": {
      "description": "original name",
      "type": "string"
    },
    "newName": {
      "description": "Id for new profile",
      "type": "string"
    },
    "newId": {
      "description": "name for new profile",
      "type": "string"
    }
  }
}

Modify - User Traffic Profile

PATCH/v11_1/profiles/utp/{id}

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

Request
HideShow
Body
{
  "name": "new-user-traffic-profile-name",
  "description": "user traffic profile description",
  "defaultAction": "ALLOW",
  "uplinkRateLimiting": {
    "uplinkRateLimitingEnabled": true,
    "uplinkRateLimitingBps": "0.10 mbps"
  },
  "downlinkRateLimiting": {
    "downlinkRateLimitingEnabled": true,
    "downlinkRateLimitingBps": "0.10 mbps"
  },
  "ipAclRules": [
    {
      "description": "acl rule description",
      "uplinkRateLimitingEnabled": true,
      "uplinkRateLimitingMbps": 0.5,
      "downlinkRateLimitingEnabled": true,
      "downlinkRateLimitingMbps": 0.5,
      "enableSourceIpSubnet": true,
      "sourceIp": "172.17.26.55",
      "sourceIpMask": "255.255.255.0",
      "enableSourcePortRange": false,
      "sourceMinPort": 89,
      "enableDestinationPortRange": false,
      "destinationIp": "172.17.26.60",
      "destinationIpMask": "255.255.0.0",
      "protocol": "TCP",
      "action": "ALLOW",
      "direction": "UPSTREAM"
    },
    {
      "description": "acl rule description",
      "enableSourceIpSubnet": true,
      "sourceIp": "255.17.26.87",
      "sourceIpMask": "255.255.255.0",
      "destinationIp": "172.17.26.69",
      "destinationIpMask": "255.255.0.0",
      "protocol": "UDP",
      "action": "BLOCK",
      "direction": "UPSTREAM"
    }
  ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the user traffic profile",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the user traffic profile",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the user traffic profile",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "defaultAction" : {
            "description" : "Default action",
            "type" : "string",
            "enum" : [ "BLOCK", "ALLOW" ]
        },
        "uplinkRateLimiting" : {
            "description" : "Uplink rate limiting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "uplinkRateLimitingEnabled" : {
                    "description" : "Uplink rate limiting enabled or disabled",
                    "type" : "boolean"
                },
                "uplinkRateLimitingBps" : {
                    "description" : "Uplink rate limiting, range 0.1 ~ 200 mpbs",
                    "type" : "string",
                    "pattern" : "\S+ mbps$"
                }
            }
        },
        "downlinkRateLimiting" : {
            "description" : "Downlink rate limiting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "downlinkRateLimitingEnabled" : {
                    "description" : "Downlink rate limiting enabled or disabled",
                    "type" : "boolean"
                },
                "downlinkRateLimitingBps" : {
                    "description" : "Downlink rate limiting, range 0.1 ~ 200 mpbs",
                    "type" : "string",
                    "pattern" : "\S+ mbps$"
                }
            }
        },
        "ipAclRules" : {
            "type" : "array",
            "description" : "Traffic access control list",
            "items" : {
                "type" : "object",
                "description" : "Traffic access control list",
                "additionalProperties" : false,
                "properties" : {
                    "priority" : {
                        "type" : "integer",
                        "description" : "Priority"
                    },
                    "description" : {
                        "description" : "Description of the traffic access control rule",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64
                    },
                    "uplinkRateLimitingEnabled" : {
                        "description" : "Uplink rate limiting enabled",
                        "type" : "boolean"
                    },
                    "uplinkRateLimitingMbps" : {
                        "description" : "Uplink rate limiting",
                        "type" : "number"
                    },
                    "downlinkRateLimitingEnabled" : {
                        "description" : "Downlink rate limiting enabled",
                        "type" : "boolean"
                    },
                    "downlinkRateLimitingMbps" : {
                        "description" : "Downlink rate limiting",
                        "type" : "number"
                    },
                    "enableSourceIpSubnet" : {
                        "description" : "Source IP subnet enabled or disabled",
                        "type" : "boolean"
                    },
                    "ipType" : {
                        "description" : "IP Type(IPv4 or IPv6)",
                        "default" : "IPv4",
                        "type" : "string",
                        "enum" : [ "IPv4", "IPv6" ]
                    },
                    "sourceIp" : {
                        "type" : "string",
                        "description" : "Subnet network address or ip address of source IP."
                    },
                    "sourceIpMask" : {
                        "type" : "string",
                        "description" : "Subnet mask of source IP"
                    },
                    "enableSourceV6Prefix" : {
                        "description" : "Enable Source IPv6 prefix.",
                        "type" : "boolean"
                    },
                    "sourceIpV6" : {
                        "type" : "string",
                        "description" : "Source IPv6 Address."
                    },
                    "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"
                    },
                    "enableDestinationV6Prefix" : {
                        "description" : "Enable Destination IPv6 prefix.",
                        "type" : "boolean"
                    },
                    "destinationIpV6" : {
                        "type" : "string",
                        "description" : "Destination IPv6 Address."
                    },
                    "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.",
                        "type" : "string",
                        "enum" : [ "TCP", "UDP", "UDPLITE", "ICMP_ICMPV4", "ICMPV6", "IGMP", "ESP", "AH", "SCTP", "CUSTOM" ]
                    },
                    "customProtocol" : {
                        "type" : "integer",
                        "minimum" : 1,
                        "maximum" : 255,
                        "description" : "The protocol of traffic access control. Available if the protocol is set to CUSTOM."
                    },
                    "action" : {
                        "description" : "The access of traffic access control.",
                        "default" : "ALLOW",
                        "type" : "string",
                        "enum" : [ "ALLOW", "BLOCK" ]
                    },
                    "direction" : {
                        "description" : "The direction of traffic access control.",
                        "default" : "UPSTREAM",
                        "type" : "string",
                        "enum" : [ "UPSTREAM" ]
                    }
                },
                "required" : [ "action", "direction" ]
            }
        },
        "appPolicyId" : {
            "description" : "Application Policy UUID (for 5.0 and Earlier Firmware Versions)",
            "type" : "string"
        },
        "qmAppPolicyId" : {
            "description" : "Application Policy UUID",
            "type" : "string"
        },
        "urlFilteringPolicyId" : {
            "description" : "URL Filtering Policy UUID",
            "type" : "string"
        },
        "mvnoId" : {
            "description" : "Tenant UUID",
            "type" : "string"
        },
        "domainId" : {
            "description" : "Domain UUID",
            "type" : "string"
        }
    }
}
Response  204

Disable - uplinkRateLimiting

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

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

Response  204

Disable - downlinkRateLimiting

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

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

Response  204

Delete - User Traffic Profile

DELETE/v11_1/profiles/utp/{id}

Use this API command to delete an user traffic profile.

Response  204

Delete

DELETE/v11_1/profiles/utp

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

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

Authentication Profile

Retrieve List - authentication service info.

POST/v11_1/profiles/auth/authServiceList/query

Use this API command to retrieve a list of authentication service. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6",
      "serviceId": "3c5dd0c0-e9c1-11e6-b761-64006a6a50c6",
      "serviceName": "RadiusAuthenticationServer1",
      "serviceType": ""
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "ID of service",
            "type": "string"
          },
          "serviceId": {
            "description": "ID of service",
            "type": "string"
          },
          "serviceName": {
            "description": "Name of service",
            "type": "string"
          },
          "serviceType": {
            "description": "Type of service",
            "type": "string"
          }
        }
      }
    }
  }
}

IPSEC Profile

Retrieve List

GET/v11_1/profiles/tunnel/ipsec

Retrieve a list of IPSEC.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "267ef3a0-738b-11e4-96d5-0a7820524153",
      "name": "new name"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for profile",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the profile",
            "type": "string"
          },
          "name": {
            "description": "Name of the profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          }
        }
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Retrieve

GET/v11_1/profiles/tunnel/ipsec/{id}

Retrieve a IPSEC.

Response  200
HideShow
Body
{
  "id": "0b767870-ab59-11e4-87f2-000c29c1611c",
  "name": "ipsec content",
  "description": "ipsec content description",
  "serverAddr": "221.11.11.11",
  "authType": "PresharedKey",
  "preSharedKey": "2212222111",
  "ikeSecurityAssociation": {
    "ikeProposalType": "Specific",
    "ikeProposals": [
      {
        "encAlg": "AES128",
        "authAlg": "SHA1",
        "prfAlg": "UseIntegrityALG",
        "dhGroup": "Modp2048"
      },
      {
        "encAlg": "ThreeDES",
        "authAlg": "MD5",
        "prfAlg": "UseIntegrityALG",
        "dhGroup": "Modp8192"
      }
    ]
  },
  "espSecurityAssociation": {
    "espProposalType": "Specific",
    "espProposals": [
      {
        "encAlg": "AES128",
        "authAlg": "SHA1",
        "dhGroup": "Modp2048"
      },
      {
        "encAlg": "ThreeDES",
        "authAlg": "MD5",
        "dhGroup": "Modp8192"
      }
    ]
  },
  "ikeRekeyTime": 0,
  "ikeRekeyTimeUnit": "hour",
  "espRekeyTime": 0,
  "espRekeyTimeUnit": "day",
  "cmProtocolOption": {
    "cmpDhcpOpt43Subcode": 55,
    "cmpServerAddr": "cmp test addr",
    "cmpServerPath": "cmp test path"
  },
  "advancedOption": {
    "dhcpOpt43Subcode": 8,
    "retryLimit": 6,
    "replayWindow": 30,
    "ipcompEnable": "Enabled",
    "enforceNatt": "Enabled",
    "dpdDelay": 11,
    "keepAliveIntval": 2,
    "failoverRetryPeriod": 5,
    "failoverRetryInterval": 6,
    "failoverMode": "Revertive",
    "failoverPrimaryCheckInterval": 7
  },
  "ipMode": "IPV4"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "identifier of the ipsec profile",
      "type": "string"
    },
    "name": {
      "description": "name of the ipsec profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the ipsec profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "serverAddr": {
      "description": "server Addr of the ipsec profile",
      "type": "string"
    },
    "authType": {
      "description": "authentication type of the ipsec profile",
      "type": "string",
      "enum": [
        "PresharedKey",
        "Certificate"
      ]
    },
    "tunnelMode": {
      "description": "Tunnel mode of IPsec profile",
      "type": "string",
      "enum": [
        "SOFT_GRE",
        "RUCKUS_GRE"
      ]
    },
    "preSharedKey": {
      "description": "authentication preShared Key of the ipsec profile",
      "type": "string"
    },
    "ikeSecurityAssociation": {
      "description": "ikeProposal Security Association Content",
      "type": "object",
      "properties": {
        "ikeProposalType": {
          "description": "ikeProposal Type of the ipsec profile",
          "type": "string",
          "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",
                "type": "string",
                "enum": [
                  "ThreeDES",
                  "AES128",
                  "AES192",
                  "AES256"
                ]
              },
              "authAlg": {
                "description": "authAlg of ikeProposal Specific",
                "type": "string",
                "enum": [
                  "MD5",
                  "SHA1",
                  "AESXCBC",
                  "SHA256",
                  "SHA384",
                  "SHA512"
                ]
              },
              "prfAlg": {
                "description": "prfAlg of ikeProposal Specific",
                "type": "string",
                "enum": [
                  "UseIntegrityALG",
                  "PRF_MD5",
                  "PRF_SHA1",
                  "PRF_AES_CBC",
                  "PRF_AES_MAC",
                  "PRF_SHA256",
                  "PRF_SHA384",
                  "PRF_SHA512"
                ]
              },
              "dhGroup": {
                "description": "dhGroup of ikeProposal Specific",
                "type": "string",
                "enum": [
                  "Modp768",
                  "Modp1024",
                  "Modp1536",
                  "Modp2048",
                  "Modp3072",
                  "Modp4096",
                  "Modp6144",
                  "Modp8192",
                  "Ecp384"
                ]
              }
            },
            "required": [
              "encAlg",
              "authAlg",
              "dhGroup"
            ]
          }
        }
      }
    },
    "espSecurityAssociation": {
      "description": "espProposal Security Association Content",
      "type": "object",
      "properties": {
        "espProposalType": {
          "description": "espProposal Type of the ipsec profile",
          "type": "string",
          "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",
                "type": "string",
                "enum": [
                  "None",
                  "ThreeDES",
                  "AES128",
                  "AES192",
                  "AES256"
                ]
              },
              "authAlg": {
                "description": "authAlg of espProposal Specific",
                "type": "string",
                "enum": [
                  "MD5",
                  "SHA1",
                  "AESXCBC",
                  "SHA256",
                  "SHA384",
                  "SHA512"
                ]
              },
              "dhGroup": {
                "description": "dhGroup of espProposal Specific",
                "type": "string",
                "enum": [
                  "None",
                  "Modp768",
                  "Modp1024",
                  "Modp1536",
                  "Modp2048",
                  "Modp3072",
                  "Modp4096",
                  "Modp6144",
                  "Modp8192",
                  "Ecp384"
                ]
              }
            },
            "required": [
              "encAlg",
              "authAlg",
              "dhGroup"
            ]
          }
        }
      }
    },
    "ikeRekeyTime": {
      "description": "ikeRekey Time of the ipsec profile",
      "type": "number"
    },
    "ikeRekeyTimeUnit": {
      "description": "time unit",
      "type": "string",
      "enum": [
        "second",
        "minute",
        "hour",
        "day"
      ]
    },
    "espRekeyTime": {
      "description": "espRekey Time of the ipsec profile",
      "type": "number"
    },
    "espRekeyTimeUnit": {
      "description": "time unit",
      "type": "string",
      "enum": [
        "second",
        "minute",
        "hour",
        "day"
      ]
    },
    "cmProtocolOption": {
      "description": "Certificate Management Protocol Option",
      "type": "object",
      "properties": {
        "cmpDhcpOpt43Subcode": {
          "description": "Certificate Management Protocol dhcpOpt43Subcode",
          "type": "number"
        },
        "cmpServerAddr": {
          "description": "Certificate Management Protocol Server addr",
          "type": "string"
        },
        "cmpServerPath": {
          "description": "Certificate Management Protocol Server Path",
          "type": "string"
        },
        "cmpDhcpOpt43SubcodeRecipient": {
          "description": "Certificate Management Protocol dhcpOpt43SubcodeRecipient",
          "type": "number"
        },
        "cmpRecipient": {
          "description": "Certificate Management Protocol Recipient",
          "type": "string"
        }
      },
      "required": [
        "cmpDhcpOpt43Subcode"
      ]
    },
    "advancedOption": {
      "description": "advanced option Content",
      "type": "object",
      "properties": {
        "dhcpOpt43Subcode": {
          "description": "dhcpOpt43Subcode of the ipsec profile",
          "type": "number"
        },
        "retryLimit": {
          "description": "retryLimit of the ipsec profile",
          "type": "number"
        },
        "replayWindow": {
          "description": "replayWindow of the ipsec profile",
          "type": "number"
        },
        "ipcompEnable": {
          "description": "ipcomp Enable of the ipsec profile",
          "type": "string",
          "enum": [
            "Disabled",
            "Enabled"
          ]
        },
        "enforceNatt": {
          "description": "enforceNatt Enable of the ipsec profile",
          "type": "string",
          "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",
          "type": "string",
          "enum": [
            "Non_Revertive",
            "Revertive"
          ]
        },
        "failoverPrimaryCheckInterval": {
          "description": "Primary Check Interval of the failover",
          "type": "number"
        }
      }
    },
    "ipMode": {
      "description": "ipMode of the ipsec profile",
      "type": "string",
      "enum": [
        "IPV4",
        "IPV6"
      ]
    },
    "domainId": {
      "description": "Domain id of the IPSec profile",
      "type": "string"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Query List

POST/v11_1/profiles/tunnel/ipsec/query

Query a list of IPSEC. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "0b767870-ab59-11e4-87f2-000c29c1611c",
      "name": "ipsec content",
      "description": "ipsec content description",
      "serverAddr": "221.11.11.11",
      "authType": "PresharedKey",
      "preSharedKey": "2212222111",
      "ikeSecurityAssociation": {
        "ikeProposalType": "Specific",
        "ikeProposals": [
          {
            "encAlg": "AES128",
            "authAlg": "SHA1",
            "prfAlg": "UseIntegrityALG",
            "dhGroup": "Modp2048"
          },
          {
            "encAlg": "ThreeDES",
            "authAlg": "MD5",
            "prfAlg": "UseIntegrityALG",
            "dhGroup": "Modp8192"
          }
        ]
      },
      "espSecurityAssociation": {
        "espProposalType": "Specific",
        "espProposals": [
          {
            "encAlg": "AES128",
            "authAlg": "SHA1",
            "dhGroup": "Modp2048"
          },
          {
            "encAlg": "ThreeDES",
            "authAlg": "MD5",
            "dhGroup": "Modp8192"
          }
        ]
      },
      "ikeRekeyTime": 0,
      "ikeRekeyTimeUnit": "hour",
      "espRekeyTime": 0,
      "espRekeyTimeUnit": "day",
      "cmProtocolOption": {
        "cmpDhcpOpt43Subcode": 55,
        "cmpServerAddr": "cmp test addr",
        "cmpServerPath": "cmp test path"
      },
      "advancedOption": {
        "dhcpOpt43Subcode": 8,
        "retryLimit": 6,
        "replayWindow": 30,
        "ipcompEnable": "Enabled",
        "enforceNatt": "Enabled",
        "dpdDelay": 11,
        "keepAliveIntval": 2,
        "failoverRetryPeriod": 5,
        "failoverRetryInterval": 6,
        "failoverMode": "Revertive",
        "failoverPrimaryCheckInterval": 7
      },
      "ipMode": "IPV4"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "identifier of the ipsec profile",
            "type": "string"
          },
          "name": {
            "description": "name of the ipsec profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "description of the ipsec profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "serverAddr": {
            "description": "server Addr of the ipsec profile",
            "type": "string"
          },
          "authType": {
            "description": "authentication type of the ipsec profile",
            "type": "string",
            "enum": [
              "PresharedKey",
              "Certificate"
            ]
          },
          "tunnelMode": {
            "description": "Tunnel mode of IPsec profile",
            "type": "string",
            "enum": [
              "SOFT_GRE",
              "RUCKUS_GRE"
            ]
          },
          "preSharedKey": {
            "description": "authentication preShared Key of the ipsec profile",
            "type": "string"
          },
          "ikeSecurityAssociation": {
            "description": "ikeProposal Security Association Content",
            "type": "object",
            "properties": {
              "ikeProposalType": {
                "description": "ikeProposal Type of the ipsec profile",
                "type": "string",
                "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",
                      "type": "string",
                      "enum": [
                        "ThreeDES",
                        "AES128",
                        "AES192",
                        "AES256"
                      ]
                    },
                    "authAlg": {
                      "description": "authAlg of ikeProposal Specific",
                      "type": "string",
                      "enum": [
                        "MD5",
                        "SHA1",
                        "AESXCBC",
                        "SHA256",
                        "SHA384",
                        "SHA512"
                      ]
                    },
                    "prfAlg": {
                      "description": "prfAlg of ikeProposal Specific",
                      "type": "string",
                      "enum": [
                        "UseIntegrityALG",
                        "PRF_MD5",
                        "PRF_SHA1",
                        "PRF_AES_CBC",
                        "PRF_AES_MAC",
                        "PRF_SHA256",
                        "PRF_SHA384",
                        "PRF_SHA512"
                      ]
                    },
                    "dhGroup": {
                      "description": "dhGroup of ikeProposal Specific",
                      "type": "string",
                      "enum": [
                        "Modp768",
                        "Modp1024",
                        "Modp1536",
                        "Modp2048",
                        "Modp3072",
                        "Modp4096",
                        "Modp6144",
                        "Modp8192",
                        "Ecp384"
                      ]
                    }
                  },
                  "required": [
                    "encAlg",
                    "authAlg",
                    "dhGroup"
                  ]
                }
              }
            }
          },
          "espSecurityAssociation": {
            "description": "espProposal Security Association Content",
            "type": "object",
            "properties": {
              "espProposalType": {
                "description": "espProposal Type of the ipsec profile",
                "type": "string",
                "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",
                      "type": "string",
                      "enum": [
                        "None",
                        "ThreeDES",
                        "AES128",
                        "AES192",
                        "AES256"
                      ]
                    },
                    "authAlg": {
                      "description": "authAlg of espProposal Specific",
                      "type": "string",
                      "enum": [
                        "MD5",
                        "SHA1",
                        "AESXCBC",
                        "SHA256",
                        "SHA384",
                        "SHA512"
                      ]
                    },
                    "dhGroup": {
                      "description": "dhGroup of espProposal Specific",
                      "type": "string",
                      "enum": [
                        "None",
                        "Modp768",
                        "Modp1024",
                        "Modp1536",
                        "Modp2048",
                        "Modp3072",
                        "Modp4096",
                        "Modp6144",
                        "Modp8192",
                        "Ecp384"
                      ]
                    }
                  },
                  "required": [
                    "encAlg",
                    "authAlg",
                    "dhGroup"
                  ]
                }
              }
            }
          },
          "ikeRekeyTime": {
            "description": "ikeRekey Time of the ipsec profile",
            "type": "number"
          },
          "ikeRekeyTimeUnit": {
            "description": "time unit",
            "type": "string",
            "enum": [
              "second",
              "minute",
              "hour",
              "day"
            ]
          },
          "espRekeyTime": {
            "description": "espRekey Time of the ipsec profile",
            "type": "number"
          },
          "espRekeyTimeUnit": {
            "description": "time unit",
            "type": "string",
            "enum": [
              "second",
              "minute",
              "hour",
              "day"
            ]
          },
          "cmProtocolOption": {
            "description": "Certificate Management Protocol Option",
            "type": "object",
            "properties": {
              "cmpDhcpOpt43Subcode": {
                "description": "Certificate Management Protocol dhcpOpt43Subcode",
                "type": "number"
              },
              "cmpServerAddr": {
                "description": "Certificate Management Protocol Server addr",
                "type": "string"
              },
              "cmpServerPath": {
                "description": "Certificate Management Protocol Server Path",
                "type": "string"
              },
              "cmpDhcpOpt43SubcodeRecipient": {
                "description": "Certificate Management Protocol dhcpOpt43SubcodeRecipient",
                "type": "number"
              },
              "cmpRecipient": {
                "description": "Certificate Management Protocol Recipient",
                "type": "string"
              }
            },
            "required": [
              "cmpDhcpOpt43Subcode"
            ]
          },
          "advancedOption": {
            "description": "advanced option Content",
            "type": "object",
            "properties": {
              "dhcpOpt43Subcode": {
                "description": "dhcpOpt43Subcode of the ipsec profile",
                "type": "number"
              },
              "retryLimit": {
                "description": "retryLimit of the ipsec profile",
                "type": "number"
              },
              "replayWindow": {
                "description": "replayWindow of the ipsec profile",
                "type": "number"
              },
              "ipcompEnable": {
                "description": "ipcomp Enable of the ipsec profile",
                "type": "string",
                "enum": [
                  "Disabled",
                  "Enabled"
                ]
              },
              "enforceNatt": {
                "description": "enforceNatt Enable of the ipsec profile",
                "type": "string",
                "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",
                "type": "string",
                "enum": [
                  "Non_Revertive",
                  "Revertive"
                ]
              },
              "failoverPrimaryCheckInterval": {
                "description": "Primary Check Interval of the failover",
                "type": "number"
              }
            }
          },
          "ipMode": {
            "description": "ipMode of the ipsec profile",
            "type": "string",
            "enum": [
              "IPV4",
              "IPV6"
            ]
          },
          "domainId": {
            "description": "Domain id of the IPSec profile",
            "type": "string"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    }
  }
}

Create ipsec

POST/v11_1/profiles/tunnel/ipsec

Create a new ipsec.

Request
HideShow
Body
{
  "name": "ipsec create",
  "description": "ipsec create description",
  "serverAddr": "111.11.11.11",
  "tunnelMode": "SOFT_GRE",
  "authType": "PresharedKey",
  "preSharedKey": "11111111111",
  "ikeRekeyTime": 4,
  "espRekeyTime": 1,
  "ikeRekeyTimeUnit": "minute",
  "espRekeyTimeUnit": "day",
  "ipMode": "IPV4"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "identifier of the ipsec profile",
      "type": "string"
    },
    "name": {
      "description": "name of the ipsec profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the ipsec profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "serverAddr": {
      "description": "server Addr of the ipsec profile",
      "type": "string"
    },
    "authType": {
      "description": "authentication type of the ipsec profile",
      "type": "string",
      "enum": [
        "PresharedKey",
        "Certificate"
      ]
    },
    "tunnelMode": {
      "description": "Tunnel mode of IPsec profile",
      "type": "string",
      "enum": [
        "SOFT_GRE",
        "RUCKUS_GRE"
      ]
    },
    "preSharedKey": {
      "description": "authentication preShared Key of the ipsec profile",
      "type": "string"
    },
    "ikeSecurityAssociation": {
      "description": "ikeProposal Security Association Content",
      "type": "object",
      "properties": {
        "ikeProposalType": {
          "description": "ikeProposal Type of the ipsec profile",
          "type": "string",
          "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",
                "type": "string",
                "enum": [
                  "ThreeDES",
                  "AES128",
                  "AES192",
                  "AES256"
                ]
              },
              "authAlg": {
                "description": "authAlg of ikeProposal Specific",
                "type": "string",
                "enum": [
                  "MD5",
                  "SHA1",
                  "AESXCBC",
                  "SHA256",
                  "SHA384",
                  "SHA512"
                ]
              },
              "prfAlg": {
                "description": "prfAlg of ikeProposal Specific",
                "type": "string",
                "enum": [
                  "UseIntegrityALG",
                  "PRF_MD5",
                  "PRF_SHA1",
                  "PRF_AES_CBC",
                  "PRF_AES_MAC",
                  "PRF_SHA256",
                  "PRF_SHA384",
                  "PRF_SHA512"
                ]
              },
              "dhGroup": {
                "description": "dhGroup of ikeProposal Specific",
                "type": "string",
                "enum": [
                  "Modp768",
                  "Modp1024",
                  "Modp1536",
                  "Modp2048",
                  "Modp3072",
                  "Modp4096",
                  "Modp6144",
                  "Modp8192",
                  "Ecp384"
                ]
              }
            },
            "required": [
              "encAlg",
              "authAlg",
              "dhGroup"
            ]
          }
        }
      }
    },
    "espSecurityAssociation": {
      "description": "espProposal Security Association Content",
      "type": "object",
      "properties": {
        "espProposalType": {
          "description": "espProposal Type of the ipsec profile",
          "type": "string",
          "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",
                "type": "string",
                "enum": [
                  "None",
                  "ThreeDES",
                  "AES128",
                  "AES192",
                  "AES256"
                ]
              },
              "authAlg": {
                "description": "authAlg of espProposal Specific",
                "type": "string",
                "enum": [
                  "MD5",
                  "SHA1",
                  "AESXCBC",
                  "SHA256",
                  "SHA384",
                  "SHA512"
                ]
              },
              "dhGroup": {
                "description": "dhGroup of espProposal Specific",
                "type": "string",
                "enum": [
                  "None",
                  "Modp768",
                  "Modp1024",
                  "Modp1536",
                  "Modp2048",
                  "Modp3072",
                  "Modp4096",
                  "Modp6144",
                  "Modp8192",
                  "Ecp384"
                ]
              }
            },
            "required": [
              "encAlg",
              "authAlg",
              "dhGroup"
            ]
          }
        }
      }
    },
    "ikeRekeyTime": {
      "description": "ikeRekey Time of the ipsec profile",
      "type": "number"
    },
    "ikeRekeyTimeUnit": {
      "description": "time unit",
      "type": "string",
      "enum": [
        "second",
        "minute",
        "hour",
        "day"
      ]
    },
    "espRekeyTime": {
      "description": "espRekey Time of the ipsec profile",
      "type": "number"
    },
    "espRekeyTimeUnit": {
      "description": "time unit",
      "type": "string",
      "enum": [
        "second",
        "minute",
        "hour",
        "day"
      ]
    },
    "cmProtocolOption": {
      "description": "Certificate Management Protocol Option",
      "type": "object",
      "properties": {
        "cmpDhcpOpt43Subcode": {
          "description": "Certificate Management Protocol dhcpOpt43Subcode",
          "type": "number"
        },
        "cmpServerAddr": {
          "description": "Certificate Management Protocol Server addr",
          "type": "string"
        },
        "cmpServerPath": {
          "description": "Certificate Management Protocol Server Path",
          "type": "string"
        },
        "cmpDhcpOpt43SubcodeRecipient": {
          "description": "Certificate Management Protocol dhcpOpt43SubcodeRecipient",
          "type": "number"
        },
        "cmpRecipient": {
          "description": "Certificate Management Protocol Recipient",
          "type": "string"
        }
      },
      "required": [
        "cmpDhcpOpt43Subcode"
      ]
    },
    "advancedOption": {
      "description": "advanced option Content",
      "type": "object",
      "properties": {
        "dhcpOpt43Subcode": {
          "description": "dhcpOpt43Subcode of the ipsec profile",
          "type": "number"
        },
        "retryLimit": {
          "description": "retryLimit of the ipsec profile",
          "type": "number"
        },
        "replayWindow": {
          "description": "replayWindow of the ipsec profile",
          "type": "number"
        },
        "ipcompEnable": {
          "description": "ipcomp Enable of the ipsec profile",
          "type": "string",
          "enum": [
            "Disabled",
            "Enabled"
          ]
        },
        "enforceNatt": {
          "description": "enforceNatt Enable of the ipsec profile",
          "type": "string",
          "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",
          "type": "string",
          "enum": [
            "Non_Revertive",
            "Revertive"
          ]
        },
        "failoverPrimaryCheckInterval": {
          "description": "Primary Check Interval of the failover",
          "type": "number"
        }
      }
    },
    "ipMode": {
      "description": "ipMode of the ipsec profile",
      "type": "string",
      "enum": [
        "IPV4",
        "IPV6"
      ]
    },
    "domainId": {
      "description": "Domain id of the IPSec profile",
      "type": "string"
    }
  },
  "required": [
    "name",
    "ikeRekeyTime",
    "espRekeyTime",
    "ipMode"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v11_1/profiles/tunnel/ipsec/{id}

Modify a specific ipsec basic.

Request
HideShow
Body
{
  "name": "ipsec moify",
  "description": "ipsec modify description",
  "serverAddr": "221.11.11.11",
  "authType": "PresharedKey",
  "preSharedKey": "2212222111",
  "ikeRekeyTime": 5,
  "espRekeyTime": 6,
  "ikeRekeyTimeUnit": "hour",
  "espRekeyTimeUnit": "day",
  "ikeSecurityAssociation": {
    "ikeProposalType": "Specific",
    "ikeProposals": [
      {
        "encAlg": "AES128",
        "authAlg": "SHA1",
        "prfAlg": "UseIntegrityALG",
        "dhGroup": "Modp2048"
      },
      {
        "encAlg": "ThreeDES",
        "authAlg": "MD5",
        "prfAlg": "UseIntegrityALG",
        "dhGroup": "Modp8192"
      }
    ]
  },
  "espSecurityAssociation": {
    "espProposalType": "Specific",
    "espProposals": [
      {
        "encAlg": "AES128",
        "authAlg": "SHA1",
        "dhGroup": "Modp2048"
      },
      {
        "encAlg": "ThreeDES",
        "authAlg": "MD5",
        "dhGroup": "Modp8192"
      }
    ]
  },
  "cmProtocolOption": {
    "cmpDhcpOpt43Subcode": 55,
    "cmpServerAddr": "cmp test addr",
    "cmpServerPath": "cmp test path"
  },
  "advancedOption": {
    "dhcpOpt43Subcode": 8,
    "retryLimit": 6,
    "replayWindow": 30,
    "ipcompEnable": "Enabled",
    "enforceNatt": "Enabled",
    "dpdDelay": 11,
    "keepAliveIntval": 2,
    "failoverRetryPeriod": 5,
    "failoverRetryInterval": 6,
    "failoverMode": "Revertive",
    "failoverPrimaryCheckInterval": 7
  },
  "ipMode": "IPV6"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "identifier of the ipsec profile",
      "type": "string"
    },
    "name": {
      "description": "name of the ipsec profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the ipsec profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "serverAddr": {
      "description": "server Addr of the ipsec profile",
      "type": "string"
    },
    "authType": {
      "description": "authentication type of the ipsec profile",
      "type": "string",
      "enum": [
        "PresharedKey",
        "Certificate"
      ]
    },
    "preSharedKey": {
      "description": "authentication preShared Key of the ipsec profile",
      "type": "string"
    },
    "ikeSecurityAssociation": {
      "description": "ikeProposal Security Association Content",
      "type": "object",
      "properties": {
        "ikeProposalType": {
          "description": "ikeProposal Type of the ipsec profile",
          "type": "string",
          "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",
                "type": "string",
                "enum": [
                  "ThreeDES",
                  "AES128",
                  "AES192",
                  "AES256"
                ]
              },
              "authAlg": {
                "description": "authAlg of ikeProposal Specific",
                "type": "string",
                "enum": [
                  "MD5",
                  "SHA1",
                  "AESXCBC",
                  "SHA256",
                  "SHA384",
                  "SHA512"
                ]
              },
              "prfAlg": {
                "description": "prfAlg of ikeProposal Specific",
                "type": "string",
                "enum": [
                  "UseIntegrityALG",
                  "PRF_MD5",
                  "PRF_SHA1",
                  "PRF_AES_CBC",
                  "PRF_AES_MAC",
                  "PRF_SHA256",
                  "PRF_SHA384",
                  "PRF_SHA512"
                ]
              },
              "dhGroup": {
                "description": "dhGroup of ikeProposal Specific",
                "type": "string",
                "enum": [
                  "Modp768",
                  "Modp1024",
                  "Modp1536",
                  "Modp2048",
                  "Modp3072",
                  "Modp4096",
                  "Modp6144",
                  "Modp8192",
                  "Ecp384"
                ]
              }
            },
            "required": [
              "encAlg",
              "authAlg",
              "dhGroup"
            ]
          }
        }
      }
    },
    "espSecurityAssociation": {
      "description": "espProposal Security Association Content",
      "type": "object",
      "properties": {
        "espProposalType": {
          "description": "espProposal Type of the ipsec profile",
          "type": "string",
          "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",
                "type": "string",
                "enum": [
                  "None",
                  "ThreeDES",
                  "AES128",
                  "AES192",
                  "AES256"
                ]
              },
              "authAlg": {
                "description": "authAlg of espProposal Specific",
                "type": "string",
                "enum": [
                  "MD5",
                  "SHA1",
                  "AESXCBC",
                  "SHA256",
                  "SHA384",
                  "SHA512"
                ]
              },
              "dhGroup": {
                "description": "dhGroup of espProposal Specific",
                "type": "string",
                "enum": [
                  "None",
                  "Modp768",
                  "Modp1024",
                  "Modp1536",
                  "Modp2048",
                  "Modp3072",
                  "Modp4096",
                  "Modp6144",
                  "Modp8192",
                  "Ecp384"
                ]
              }
            },
            "required": [
              "encAlg",
              "authAlg",
              "dhGroup"
            ]
          }
        }
      }
    },
    "ikeRekeyTime": {
      "description": "ikeRekey Time of the ipsec profile",
      "type": "number"
    },
    "ikeRekeyTimeUnit": {
      "description": "time unit",
      "type": "string",
      "enum": [
        "second",
        "minute",
        "hour",
        "day"
      ]
    },
    "espRekeyTime": {
      "description": "espRekey Time of the ipsec profile",
      "type": "number"
    },
    "espRekeyTimeUnit": {
      "description": "time unit",
      "type": "string",
      "enum": [
        "second",
        "minute",
        "hour",
        "day"
      ]
    },
    "cmProtocolOption": {
      "description": "Certificate Management Protocol Option",
      "type": "object",
      "properties": {
        "cmpDhcpOpt43Subcode": {
          "description": "Certificate Management Protocol dhcpOpt43Subcode",
          "type": "number"
        },
        "cmpServerAddr": {
          "description": "Certificate Management Protocol Server addr",
          "type": "string"
        },
        "cmpServerPath": {
          "description": "Certificate Management Protocol Server Path",
          "type": "string"
        },
        "cmpDhcpOpt43SubcodeRecipient": {
          "description": "Certificate Management Protocol dhcpOpt43SubcodeRecipient",
          "type": "number"
        },
        "cmpRecipient": {
          "description": "Certificate Management Protocol Recipient",
          "type": "string"
        }
      },
      "required": [
        "cmpDhcpOpt43Subcode"
      ]
    },
    "advancedOption": {
      "description": "advanced option Content",
      "type": "object",
      "properties": {
        "dhcpOpt43Subcode": {
          "description": "dhcpOpt43Subcode of the ipsec profile",
          "type": "number"
        },
        "retryLimit": {
          "description": "retryLimit of the ipsec profile",
          "type": "number"
        },
        "replayWindow": {
          "description": "replayWindow of the ipsec profile",
          "type": "number"
        },
        "ipcompEnable": {
          "description": "ipcomp Enable of the ipsec profile",
          "type": "string",
          "enum": [
            "Disabled",
            "Enabled"
          ]
        },
        "enforceNatt": {
          "description": "enforceNatt Enable of the ipsec profile",
          "type": "string",
          "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",
          "type": "string",
          "enum": [
            "Non_Revertive",
            "Revertive"
          ]
        },
        "failoverPrimaryCheckInterval": {
          "description": "Primary Check Interval of the failover",
          "type": "number"
        }
      }
    },
    "ipMode": {
      "description": "ipMode of the ipsec profile",
      "type": "string",
      "enum": [
        "IPV4",
        "IPV6"
      ]
    },
    "domainId": {
      "description": "Domain id of the IPSec profile",
      "type": "string"
    }
  }
}
Response  204

Delete

DELETE/v11_1/profiles/tunnel/ipsec/{id}

Delete a ipsec.

Response  204

Delete

DELETE/v11_1/profiles/tunnel/ipsec

Delete multiple ipsec.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Split Tunnel Profile

Get Split Tunnel Profiles

GET/v11_1/rkszones/{zoneId}/splitTunnelProfiles

Get a ID list of split tunnel profile in this Zone.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "firstIndex": 0,
  "hasMore": false,
  "list": [
    {
      "name": "stp1",
      "id": "3edcf8e0-8a3c-11e8-b732-000000958991"
    },
    {
      "name": "stp2",
      "id": "d30164d0-8a54-11e8-b732-000000958991"
    }
  ]
}
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": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          }
        }
      }
    }
  }
}

Get Split Tunnel Profile

GET/v11_1/rkszones/{zoneId}/splitTunnelProfiles/{id}

Get a split tunnel profile by ID.

Response  200
HideShow
Body
{
  "name": "stp1",
  "id": "3edcf8e0-8a3c-11e8-b732-000000958991",
  "description": "Created from PublicAPI directly.",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "zoneId": "8f941aa3-e84c-477c-bdbb-d2f8c22e3eb9",
  "defaultAction": "LBO",
  "rules": [
    {
      "destinationIp": "1.1.1.1",
      "destinationIpMask": "255.255.255.0"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "tenantId": {
      "type": "string"
    },
    "domainId": {
      "type": "string"
    },
    "zoneId": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "rules": {
      "description": "Exception Address List(Destination rule) of split tunnel profile",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "destinationIp": {
            "description": "Destination IP of split tunnel profile rule",
            "type": "string"
          },
          "destinationIpMask": {
            "description": "Destination IP mask of split tunnel profile rule",
            "type": "string"
          }
        },
        "required": [
          "destinationIp",
          "destinationIpMask"
        ]
      }
    },
    "defaultAction": {
      "type": "string"
    }
  }
}

Query Split Tunnel Profiles

POST/v11_1/rkszones/splitTunnelProfiles/query

Use this API command to retrieve a list of split tunnel profile by query criteria. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "firstIndex": 0,
  "hasMore": false,
  "extra": null,
  "list": [
    {
      "name": "stp1",
      "id": "3edcf8e0-8a3c-11e8-b732-000000958991",
      "description": "Created from PublicAPI directly.",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "zoneId": "8f941aa3-e84c-477c-bdbb-d2f8c22e3eb9",
      "defaultAction": "LBO",
      "rules": [
        {
          "destinationIp": "1.1.1.1",
          "destinationIpMask": "255.255.255.0"
        }
      ]
    },
    {
      "name": "stp2",
      "id": "d30164d0-8a54-11e8-b732-000000958991",
      "description": null,
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "zoneId": "8f941aa3-e84c-477c-bdbb-d2f8c22e3eb9",
      "defaultAction": "TUNNEL",
      "rules": [
        {
          "destinationIp": "1.1.2.1",
          "destinationIpMask": "255.255.255.0"
        },
        {
          "destinationIp": "1.1.3.1",
          "destinationIpMask": "255.255.255.0"
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "tenantId": {
            "type": "string"
          },
          "domainId": {
            "type": "string"
          },
          "zoneId": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "rules": {
            "description": "Exception Address List(Destination rule) of split tunnel profile",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "destinationIp": {
                  "description": "Destination IP of split tunnel profile rule",
                  "type": "string"
                },
                "destinationIpMask": {
                  "description": "Destination IP mask of split tunnel profile rule",
                  "type": "string"
                }
              },
              "required": [
                "destinationIp",
                "destinationIpMask"
              ]
            }
          },
          "defaultAction": {
            "type": "string"
          }
        }
      }
    }
  }
}

Create Split Tunnel Profile

POST/v11_1/rkszones/{zoneId}/splitTunnelProfiles

Create a split tunnel profile.

Request
HideShow
Body
{
  "name": "stp1",
  "description": "Created from PublicAPI directly.",
  "defaultAction": "LBO",
  "rules": [
    {
      "destinationIp": "1.1.1.1",
      "destinationIpMask": "255.255.255.0"
    },
    {
      "destinationIp": "1.1.2.1",
      "destinationIpMask": "255.255.255.0"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "rules": {
      "description": "Exception Address List(Destination rule) of split tunnel profile",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "destinationIp": {
            "description": "Destination IP of split tunnel profile rule",
            "type": "string"
          },
          "destinationIpMask": {
            "description": "Destination IP mask of split tunnel profile rule",
            "type": "string"
          }
        },
        "required": [
          "destinationIp",
          "destinationIpMask"
        ]
      }
    },
    "defaultAction": {
      "description": "Forwarding Mode of split tunnel profile",
      "type": "string",
      "enum": [
        "LBO",
        "TUNNEL"
      ],
      "default": "LBO"
    }
  },
  "required": [
    "name",
    "rules",
    "defaultAction"
  ]
}
Response  200
HideShow
Body
{
  "id": "3edcf8e0-8a3c-11e8-b732-000000958991"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Entire Split Tunnel Profile

PUT/v11_1/rkszones/{zoneId}/splitTunnelProfiles/{id}

Use this API command to modify entire information of a split tunnel profile.

Request
HideShow
Body
{
  "name": "stp1",
  "description": "Created from PublicAPI directly.",
  "defaultAction": "LBO",
  "rules": [
    {
      "destinationIp": "1.1.1.1",
      "destinationIpMask": "255.255.255.0"
    },
    {
      "destinationIp": "1.1.2.1",
      "destinationIpMask": "255.255.255.0"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "rules": {
      "description": "Exception Address List(Destination rule) of split tunnel profile",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "destinationIp": {
            "description": "Destination IP of split tunnel profile rule",
            "type": "string"
          },
          "destinationIpMask": {
            "description": "Destination IP mask of split tunnel profile rule",
            "type": "string"
          }
        },
        "required": [
          "destinationIp",
          "destinationIpMask"
        ]
      }
    },
    "defaultAction": {
      "description": "Forwarding Mode of split tunnel profile",
      "type": "string",
      "enum": [
        "LBO",
        "TUNNEL"
      ]
    }
  },
  "required": [
    "name",
    "rules",
    "defaultAction"
  ]
}
Response  204

Modify Split Tunnel Profile

PATCH/v11_1/rkszones/{zoneId}/splitTunnelProfiles/{id}

Use this API command to modify a split tunnel profile.

Request
HideShow
Body
{
  "name": "stp2",
  "defaultAction": "LBO",
  "rules": [
    {
      "destinationIp": "1.1.2.1",
      "destinationIpMask": "255.255.255.0"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "rules": {
      "description": "Exception Address List(Destination rule) of split tunnel profile",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "destinationIp": {
            "description": "Destination IP of split tunnel profile rule",
            "type": "string"
          },
          "destinationIpMask": {
            "description": "Destination IP mask of split tunnel profile rule",
            "type": "string"
          }
        },
        "required": [
          "destinationIp",
          "destinationIpMask"
        ]
      }
    },
    "defaultAction": {
      "description": "Forwarding Mode of split tunnel profile",
      "type": "string",
      "enum": [
        "LBO",
        "TUNNEL"
      ]
    }
  }
}
Response  204

Delete Split Tunnel Profile

DELETE/v11_1/rkszones/{zoneId}/splitTunnelProfiles/{id}

Use this API command to delete a split tunnel profile by ID.

Response  204

Bulk Delete Split Tunnel Profile

DELETE/v11_1/rkszones/splitTunnelProfiles

Use this API command to delete bulk split tunnel profiles.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Hotspot 2.0 Wi-Fi Operator Profile

Retrieve List

GET/v11_1/profiles/hs20/operators

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

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "78311870-e9d8-11e6-952e-64006a6a50c6",
      "name": "hs20Op",
      "description": "",
      "domainNames": [
        "ruckuswireless.com"
      ],
      "friendlyNames": [
        {
          "language": "English",
          "name": "ruckwifi"
        }
      ],
      "certificate": null,
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "createDateTime": 1486102662007,
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "admin",
      "modifiedDateTime": 1486102662007,
      "creatorUsername": "admin",
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    }
  ],
  "extra": {}
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "type" : "integer"
        },
        "hasMore" : {
            "type" : "boolean"
        },
        "firstIndex" : {
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Identifier of the profile",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the Hotspot 2.0 Wifi operator profile",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                    },
                    "description" : {
                        "description" : "Description of the Hotspot 2.0 Wifi operator profile",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64
                    },
                    "domainNames" : {
                        "description" : "Domain names",
                        "type" : "array",
                        "items" : {
                            "description" : "Compare with FQDN, it could start with '*.'",
                            "type" : "string",
                            "pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
                        }
                    },
                    "friendlyNames" : {
                        "description" : "Friendly names",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "language" : {
                                    "description" : "Language of the friendly name",
                                    "type" : "string",
                                    "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                                },
                                "name" : {
                                    "description" : "Name of the friendly name",
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32
                                }
                            },
                            "required" : [ "language", "name" ]
                        }
                    },
                    "certificate" : {
                        "description" : "Signup security certificate",
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "domainId" : {
                        "description" : "Domain Id",
                        "type" : "string"
                    },
                    "adviceOfCharges" : {
                        "description" : "Network’s Advice of Charge for using the Wi-Fi service",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "type" : {
                                    "type" : "string",
                                    "enum" : [ "TIME_BASED", "DATA_VOLUME_BASED", "TIME_AND_DATA_VOLUME_BASED", "UNLIMITED" ]
                                },
                                "naiRealm" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "names" : {
                                            "type" : "array",
                                            "items" : {
                                                "type" : "string",
                                                "maxLength" : 253
                                            }
                                        },
                                        "encoding" : {
                                            "type" : "string",
                                            "enum" : [ "RFC4282", "UTF8" ]
                                        }
                                    },
                                    "required" : [ "encoding" ]
                                },
                                "planInformations" : {
                                    "description" : "the Hotspot 2.0 Advice of Charge Plan Information",
                                    "type" : "array",
                                    "items" : {
                                        "type" : "object",
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "language" : {
                                                "type" : "string",
                                                "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                                            },
                                            "currency" : {
                                                "type" : "string",
                                                "enum" : [ "USD", "CAD", "CNY", "CZK", "DKK", "ANG", "EUR", "JPY", "KRW", "SEK", "TRY" ]
                                            },
                                            "content" : {
                                                "description" : "the cotent carries an XML description",
                                                "type" : "string",
                                                "maxLength" : 300
                                            }
                                        }
                                    }
                                }
                            },
                            "required" : [ "type" ]
                        }
                    },
                    "operatorIcons" : {
                        "description" : "Hotspot20 Operator Icon Metadata",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "language" : {
                                    "type" : "string",
                                    "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                                },
                                "fileName" : {
                                    "type" : "string",
                                    "minLength" : 5,
                                    "maxLength" : 64
                                },
                                "icon" : {
                                    "type" : "string"
                                }
                            },
                            "required" : [ "language", "icon" ]
                        }
                    },
                    "termsConditions" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "filename" : {
                                "maxLength" : 247,
                                "type" : "string"
                            },
                            "timestamp" : {
                                "type" : "integer",
                                "format" : "int32"
                            }
                        }
                    },
                    "createDateTime" : {
                        "description" : "Timestamp of being created",
                        "type" : "integer"
                    },
                    "modifiedDateTime" : {
                        "description" : "Timestamp of being modified",
                        "type" : "integer"
                    },
                    "creatorId" : {
                        "description" : "Creator ID",
                        "type" : "string"
                    },
                    "modifierId" : {
                        "description" : "Modifier ID",
                        "type" : "string"
                    },
                    "creatorUsername" : {
                        "description" : "Creator Name",
                        "type" : "string"
                    },
                    "modifierUsername" : {
                        "description" : "Modifier Name",
                        "type" : "string"
                    }
                },
                "required" : [ "name", "domainNames", "friendlyNames" ]
            }
        },
        "extra" : {
            "type" : "object",
            "properties" : {
                "rbacMetadata" : {
                    "type" : "array",
                    "items" : {
                        "additionalProperties" : {
                            "type" : "string"
                        },
                        "properties" : { }
                    }
                }
            }
        }
    }
}

Retrieve

GET/v11_1/profiles/hs20/operators/{id}

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

Response  200
HideShow
Body
{
  "name": "public-api-operator",
  "description": "description-changed",
  "domainNames": [
    "ruckus.com"
  ],
  "friendlyNames": [
    {
      "language": "English",
      "name": "ruckus"
    }
  ],
  "certificate": {
    "id": "certificateID",
    "name": "certificateName"
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the profile",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the Hotspot 2.0 Wifi operator profile",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot 2.0 Wifi operator profile",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "domainNames" : {
            "description" : "Domain names",
            "type" : "array",
            "items" : {
                "description" : "Compare with FQDN, it could start with '*.'",
                "type" : "string",
                "pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
            }
        },
        "friendlyNames" : {
            "description" : "Friendly names",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "language" : {
                        "description" : "Language of the friendly name",
                        "type" : "string",
                        "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                    },
                    "name" : {
                        "description" : "Name of the friendly name",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32
                    }
                },
                "required" : [ "language", "name" ]
            }
        },
        "certificate" : {
            "description" : "Signup security certificate",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "domainId" : {
            "description" : "Domain Id",
            "type" : "string"
        },
        "adviceOfCharges" : {
            "description" : "Network’s Advice of Charge for using the Wi-Fi service",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "type" : {
                        "type" : "string",
                        "enum" : [ "TIME_BASED", "DATA_VOLUME_BASED", "TIME_AND_DATA_VOLUME_BASED", "UNLIMITED" ]
                    },
                    "naiRealm" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "names" : {
                                "type" : "array",
                                "items" : {
                                    "type" : "string",
                                    "maxLength" : 253
                                }
                            },
                            "encoding" : {
                                "type" : "string",
                                "enum" : [ "RFC4282", "UTF8" ]
                            }
                        },
                        "required" : [ "encoding" ]
                    },
                    "planInformations" : {
                        "description" : "the Hotspot 2.0 Advice of Charge Plan Information",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "language" : {
                                    "type" : "string",
                                    "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                                },
                                "currency" : {
                                    "type" : "string",
                                    "enum" : [ "USD", "CAD", "CNY", "CZK", "DKK", "ANG", "EUR", "JPY", "KRW", "SEK", "TRY" ]
                                },
                                "content" : {
                                    "description" : "the cotent carries an XML description",
                                    "type" : "string",
                                    "maxLength" : 300
                                }
                            }
                        }
                    }
                },
                "required" : [ "type" ]
            }
        },
        "operatorIcons" : {
            "description" : "Hotspot20 Operator Icon Metadata",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "language" : {
                        "type" : "string",
                        "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                    },
                    "fileName" : {
                        "type" : "string",
                        "minLength" : 5,
                        "maxLength" : 64
                    },
                    "icon" : {
                        "type" : "string"
                    }
                },
                "required" : [ "language", "icon" ]
            }
        },
        "termsConditions" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "filename" : {
                    "maxLength" : 247,
                    "type" : "string"
                },
                "timestamp" : {
                    "type" : "integer",
                    "format" : "int32"
                }
            }
        },
        "createDateTime" : {
            "description" : "Timestamp of being created",
            "type" : "integer"
        },
        "modifiedDateTime" : {
            "description" : "Timestamp of being modified",
            "type" : "integer"
        },
        "creatorId" : {
            "description" : "Creator ID",
            "type" : "string"
        },
        "modifierId" : {
            "description" : "Modifier ID",
            "type" : "string"
        },
        "creatorUsername" : {
            "description" : "Creator Name",
            "type" : "string"
        },
        "modifierUsername" : {
            "description" : "Modifier Name",
            "type" : "string"
        }
    },
    "required" : [ "name", "domainNames", "friendlyNames" ]
}

Query hotspot 2.0 Wi-Fi operators

POST/v11_1/profiles/hs20/operators/query

Query hotspot 2.0 Wi-Fi operators. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "78311870-e9d8-11e6-952e-64006a6a50c6",
      "name": "hs20Op",
      "description": "",
      "domainNames": [
        "ruckuswireless.com"
      ],
      "friendlyNames": [
        {
          "language": "English",
          "name": "ruckwifi"
        }
      ],
      "certificate": null,
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "createDateTime": 1486102662007,
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "admin",
      "modifiedDateTime": 1486102662007,
      "creatorUsername": "admin",
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    }
  ],
  "extra": {}
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "type" : "integer"
        },
        "hasMore" : {
            "type" : "boolean"
        },
        "firstIndex" : {
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Identifier of the profile",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the Hotspot 2.0 Wifi operator profile",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                    },
                    "description" : {
                        "description" : "Description of the Hotspot 2.0 Wifi operator profile",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64
                    },
                    "domainNames" : {
                        "description" : "Domain names",
                        "type" : "array",
                        "items" : {
                            "description" : "Compare with FQDN, it could start with '*.'",
                            "type" : "string",
                            "pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
                        }
                    },
                    "friendlyNames" : {
                        "description" : "Friendly names",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "language" : {
                                    "description" : "Language of the friendly name",
                                    "type" : "string",
                                    "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                                },
                                "name" : {
                                    "description" : "Name of the friendly name",
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 32
                                }
                            },
                            "required" : [ "language", "name" ]
                        }
                    },
                    "certificate" : {
                        "description" : "Signup security certificate",
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "domainId" : {
                        "description" : "Domain Id",
                        "type" : "string"
                    },
                    "adviceOfCharges" : {
                        "description" : "Network’s Advice of Charge for using the Wi-Fi service",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "type" : {
                                    "type" : "string",
                                    "enum" : [ "TIME_BASED", "DATA_VOLUME_BASED", "TIME_AND_DATA_VOLUME_BASED", "UNLIMITED" ]
                                },
                                "naiRealm" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "names" : {
                                            "type" : "array",
                                            "items" : {
                                                "type" : "string",
                                                "maxLength" : 253
                                            }
                                        },
                                        "encoding" : {
                                            "type" : "string",
                                            "enum" : [ "RFC4282", "UTF8" ]
                                        }
                                    },
                                    "required" : [ "encoding" ]
                                },
                                "planInformations" : {
                                    "description" : "the Hotspot 2.0 Advice of Charge Plan Information",
                                    "type" : "array",
                                    "items" : {
                                        "type" : "object",
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "language" : {
                                                "type" : "string",
                                                "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                                            },
                                            "currency" : {
                                                "type" : "string",
                                                "enum" : [ "USD", "CAD", "CNY", "CZK", "DKK", "ANG", "EUR", "JPY", "KRW", "SEK", "TRY" ]
                                            },
                                            "content" : {
                                                "description" : "the cotent carries an XML description",
                                                "type" : "string",
                                                "maxLength" : 300
                                            }
                                        }
                                    }
                                }
                            },
                            "required" : [ "type" ]
                        }
                    },
                    "operatorIcons" : {
                        "description" : "Hotspot20 Operator Icon Metadata",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "language" : {
                                    "type" : "string",
                                    "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                                },
                                "fileName" : {
                                    "type" : "string",
                                    "minLength" : 5,
                                    "maxLength" : 64
                                },
                                "icon" : {
                                    "type" : "string"
                                }
                            },
                            "required" : [ "language", "icon" ]
                        }
                    },
                    "termsConditions" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "filename" : {
                                "maxLength" : 247,
                                "type" : "string"
                            },
                            "timestamp" : {
                                "type" : "integer",
                                "format" : "int32"
                            }
                        }
                    },
                    "createDateTime" : {
                        "description" : "Timestamp of being created",
                        "type" : "integer"
                    },
                    "modifiedDateTime" : {
                        "description" : "Timestamp of being modified",
                        "type" : "integer"
                    },
                    "creatorId" : {
                        "description" : "Creator ID",
                        "type" : "string"
                    },
                    "modifierId" : {
                        "description" : "Modifier ID",
                        "type" : "string"
                    },
                    "creatorUsername" : {
                        "description" : "Creator Name",
                        "type" : "string"
                    },
                    "modifierUsername" : {
                        "description" : "Modifier Name",
                        "type" : "string"
                    }
                },
                "required" : [ "name", "domainNames", "friendlyNames" ]
            }
        },
        "extra" : {
            "type" : "object",
            "properties" : {
                "rbacMetadata" : {
                    "type" : "array",
                    "items" : {
                        "additionalProperties" : {
                            "type" : "string"
                        },
                        "properties" : { }
                    }
                }
            }
        }
    }
}

Create

POST/v11_1/profiles/hs20/operators

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

Request
HideShow
Body
{
  "name": "public-api-operator",
  "description": "description-changed",
  "domainNames": [
    "ruckus.com"
  ],
  "friendlyNames": [
    {
      "language": "English",
      "name": "ruckus"
    }
  ],
  "certificate": {
    "id": "certificateID",
    "name": "certificateName"
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the profile",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the Hotspot 2.0 Wifi operator profile",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot 2.0 Wifi operator profile",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "domainNames" : {
            "description" : "Domain names",
            "type" : "array",
            "items" : {
                "description" : "Compare with FQDN, it could start with '*.'",
                "type" : "string",
                "pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
            }
        },
        "friendlyNames" : {
            "description" : "Friendly names",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "language" : {
                        "description" : "Language of the friendly name",
                        "type" : "string",
                        "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                    },
                    "name" : {
                        "description" : "Name of the friendly name",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32
                    }
                },
                "required" : [ "language", "name" ]
            }
        },
        "certificate" : {
            "description" : "Signup security certificate",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "domainId" : {
            "description" : "Domain Id",
            "type" : "string"
        },
        "adviceOfCharges" : {
            "description" : "Network’s Advice of Charge for using the Wi-Fi service",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "type" : {
                        "type" : "string",
                        "enum" : [ "TIME_BASED", "DATA_VOLUME_BASED", "TIME_AND_DATA_VOLUME_BASED", "UNLIMITED" ]
                    },
                    "naiRealm" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "names" : {
                                "type" : "array",
                                "items" : {
                                    "type" : "string",
                                    "maxLength" : 253
                                }
                            },
                            "encoding" : {
                                "type" : "string",
                                "enum" : [ "RFC4282", "UTF8" ]
                            }
                        },
                        "required" : [ "encoding" ]
                    },
                    "planInformations" : {
                        "description" : "the Hotspot 2.0 Advice of Charge Plan Information",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "language" : {
                                    "type" : "string",
                                    "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                                },
                                "currency" : {
                                    "type" : "string",
                                    "enum" : [ "USD", "CAD", "CNY", "CZK", "DKK", "ANG", "EUR", "JPY", "KRW", "SEK", "TRY" ]
                                },
                                "content" : {
                                    "description" : "the cotent carries an XML description",
                                    "type" : "string",
                                    "maxLength" : 300
                                }
                            }
                        }
                    }
                },
                "required" : [ "type" ]
            }
        },
        "operatorIcons" : {
            "description" : "Hotspot20 Operator Icon Metadata",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "language" : {
                        "type" : "string",
                        "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                    },
                    "fileName" : {
                        "type" : "string",
                        "minLength" : 5,
                        "maxLength" : 64
                    },
                    "icon" : {
                        "type" : "string"
                    }
                },
                "required" : [ "language", "icon" ]
            }
        },
        "termsConditions" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "filename" : {
                    "maxLength" : 247,
                    "type" : "string"
                },
                "timestamp" : {
                    "type" : "integer",
                    "format" : "int32"
                }
            }
        },
        "createDateTime" : {
            "description" : "Timestamp of being created",
            "type" : "integer"
        },
        "modifiedDateTime" : {
            "description" : "Timestamp of being modified",
            "type" : "integer"
        },
        "creatorId" : {
            "description" : "Creator ID",
            "type" : "string"
        },
        "modifierId" : {
            "description" : "Modifier ID",
            "type" : "string"
        },
        "creatorUsername" : {
            "description" : "Creator Name",
            "type" : "string"
        },
        "modifierUsername" : {
            "description" : "Modifier Name",
            "type" : "string"
        }
    },
    "required" : [ "name", "domainNames", "friendlyNames" ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Entire

PUT/v11_1/profiles/hs20/operators/{id}

Use this API command to modify entire configuration of a Hotspot 2.0 Wi-Fi operator.

Request
HideShow
Body
{
  "name": "public-api-operator",
  "description": "description-changed",
  "domainNames": [
    "ruckus.com"
  ],
  "friendlyNames": [
    {
      "language": "English",
      "name": "ruckus"
    }
  ],
  "certificate": {
    "id": "certificateID",
    "name": "certificateName"
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the profile",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the Hotspot 2.0 Wifi operator profile",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot 2.0 Wifi operator profile",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "domainNames" : {
            "description" : "Domain names",
            "type" : "array",
            "items" : {
                "description" : "Compare with FQDN, it could start with '*.'",
                "type" : "string",
                "pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
            }
        },
        "friendlyNames" : {
            "description" : "Friendly names",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "language" : {
                        "description" : "Language of the friendly name",
                        "type" : "string",
                        "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                    },
                    "name" : {
                        "description" : "Name of the friendly name",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32
                    }
                },
                "required" : [ "language", "name" ]
            }
        },
        "certificate" : {
            "description" : "Signup security certificate",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "domainId" : {
            "description" : "Domain Id",
            "type" : "string"
        },
        "adviceOfCharges" : {
            "description" : "Network’s Advice of Charge for using the Wi-Fi service",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "type" : {
                        "type" : "string",
                        "enum" : [ "TIME_BASED", "DATA_VOLUME_BASED", "TIME_AND_DATA_VOLUME_BASED", "UNLIMITED" ]
                    },
                    "naiRealm" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "names" : {
                                "type" : "array",
                                "items" : {
                                    "type" : "string",
                                    "maxLength" : 253
                                }
                            },
                            "encoding" : {
                                "type" : "string",
                                "enum" : [ "RFC4282", "UTF8" ]
                            }
                        },
                        "required" : [ "encoding" ]
                    },
                    "planInformations" : {
                        "description" : "the Hotspot 2.0 Advice of Charge Plan Information",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "language" : {
                                    "type" : "string",
                                    "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                                },
                                "currency" : {
                                    "type" : "string",
                                    "enum" : [ "USD", "CAD", "CNY", "CZK", "DKK", "ANG", "EUR", "JPY", "KRW", "SEK", "TRY" ]
                                },
                                "content" : {
                                    "description" : "the cotent carries an XML description",
                                    "type" : "string",
                                    "maxLength" : 300
                                }
                            }
                        }
                    }
                },
                "required" : [ "type" ]
            }
        },
        "operatorIcons" : {
            "description" : "Hotspot20 Operator Icon Metadata",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "language" : {
                        "type" : "string",
                        "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                    },
                    "fileName" : {
                        "type" : "string",
                        "minLength" : 5,
                        "maxLength" : 64
                    },
                    "icon" : {
                        "type" : "string"
                    }
                },
                "required" : [ "language", "icon" ]
            }
        },
        "termsConditions" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "filename" : {
                    "maxLength" : 247,
                    "type" : "string"
                },
                "timestamp" : {
                    "type" : "integer",
                    "format" : "int32"
                }
            }
        },
        "createDateTime" : {
            "description" : "Timestamp of being created",
            "type" : "integer"
        },
        "modifiedDateTime" : {
            "description" : "Timestamp of being modified",
            "type" : "integer"
        },
        "creatorId" : {
            "description" : "Creator ID",
            "type" : "string"
        },
        "modifierId" : {
            "description" : "Modifier ID",
            "type" : "string"
        },
        "creatorUsername" : {
            "description" : "Creator Name",
            "type" : "string"
        },
        "modifierUsername" : {
            "description" : "Modifier Name",
            "type" : "string"
        }
    },
    "required" : [ "name", "domainNames", "friendlyNames" ]
}
Response  204

Modify

PATCH/v11_1/profiles/hs20/operators/{id}

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

Request
HideShow
Body
{
  "name": "public-api-operator-changed",
  "description": "description-changed",
  "domainNames": [
    "ruckus.com"
  ],
  "friendlyNames": [
    {
      "language": "English",
      "name": "ruckus"
    }
  ],
  "certificate": {
    "id": "certificateID",
    "name": "certificateName"
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the profile",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the Hotspot 2.0 Wifi operator profile",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot 2.0 Wifi operator profile",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "domainNames" : {
            "description" : "Domain names",
            "type" : "array",
            "items" : {
                "description" : "Compare with FQDN, it could start with '*.'",
                "type" : "string",
                "pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
            }
        },
        "friendlyNames" : {
            "description" : "Friendly names",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "language" : {
                        "description" : "Language of the friendly name",
                        "type" : "string",
                        "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                    },
                    "name" : {
                        "description" : "Name of the friendly name",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32
                    }
                },
                "required" : [ "language", "name" ]
            }
        },
        "certificate" : {
            "description" : "Signup security certificate",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "domainId" : {
            "description" : "Domain Id",
            "type" : "string"
        },
        "adviceOfCharges" : {
            "description" : "Network’s Advice of Charge for using the Wi-Fi service",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "type" : {
                        "type" : "string",
                        "enum" : [ "TIME_BASED", "DATA_VOLUME_BASED", "TIME_AND_DATA_VOLUME_BASED", "UNLIMITED" ]
                    },
                    "naiRealm" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "names" : {
                                "type" : "array",
                                "items" : {
                                    "type" : "string",
                                    "maxLength" : 253
                                }
                            },
                            "encoding" : {
                                "type" : "string",
                                "enum" : [ "RFC4282", "UTF8" ]
                            }
                        },
                        "required" : [ "encoding" ]
                    },
                    "planInformations" : {
                        "description" : "the Hotspot 2.0 Advice of Charge Plan Information",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "language" : {
                                    "type" : "string",
                                    "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                                },
                                "currency" : {
                                    "type" : "string",
                                    "enum" : [ "USD", "CAD", "CNY", "CZK", "DKK", "ANG", "EUR", "JPY", "KRW", "SEK", "TRY" ]
                                },
                                "content" : {
                                    "description" : "the cotent carries an XML description",
                                    "type" : "string",
                                    "maxLength" : 300
                                }
                            }
                        }
                    }
                },
                "required" : [ "type" ]
            }
        },
        "operatorIcons" : {
            "description" : "Hotspot20 Operator Icon Metadata",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "language" : {
                        "type" : "string",
                        "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                    },
                    "fileName" : {
                        "type" : "string",
                        "minLength" : 5,
                        "maxLength" : 64
                    },
                    "icon" : {
                        "type" : "string"
                    }
                },
                "required" : [ "language", "icon" ]
            }
        },
        "termsConditions" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "filename" : {
                    "maxLength" : 247,
                    "type" : "string"
                },
                "timestamp" : {
                    "type" : "integer",
                    "format" : "int32"
                }
            }
        }
    }
}
Response  204

Delete

DELETE/v11_1/profiles/hs20/operators

Use this API command to delete multiple Hotspot 2.0 Wi-Fi operators.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Disable Certificate

DELETE/v11_1/profiles/hs20/operators/{id}/certificate

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

Response  204

Delete

DELETE/v11_1/profiles/hs20/operators/{id}

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

Response  204

Hotspot 2.0 Identity Provider Profile

Retrieve

GET/v11_1/profiles/hs20/identityproviders/{id}

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

Response  200
HideShow
Body
{
  "id": "1fb20eaf-7b9b-40c7-8b9b-7d69d6165176",
  "name": "hs20IdentithexternalOSU",
  "description": "",
  "realms": [
    {
      "name": "reamlll",
      "encoding": "RFC4282",
      "eapMethods": [
        {
          "type": "NA",
          "authSettings": null
        },
        {
          "type": "NA",
          "authSettings": null
        },
        {
          "type": "NA",
          "authSettings": null
        },
        {
          "type": "NA",
          "authSettings": null
        }
      ]
    }
  ],
  "plmns": [
    {
      "mcc": "866",
      "mnc": "02"
    }
  ],
  "homeOis": [
    {
      "name": "enter_name",
      "oi": "999aaa"
    }
  ],
  "authentications": [
    {
      "id": "868b0b20-8598-11e4-8acc-08002716c79f",
      "name": "globalRadius",
      "realm": "globalAuth",
      "serviceType": "RADIUS",
      "vlanId": 23
    },
    {
      "id": null,
      "name": null,
      "realm": "No Match",
      "serviceType": "NA",
      "vlanId": null
    },
    {
      "id": null,
      "name": null,
      "realm": "Unspecified",
      "serviceType": "NA",
      "vlanId": null
    }
  ],
  "accountings": [
    {
      "id": "789ff6b0-8598-11e4-8acc-08002716c79f",
      "name": "globalRadiusAcct",
      "realm": "globalAcct",
      "serviceType": "RADIUS"
    },
    {
      "id": null,
      "name": null,
      "realm": "No Match",
      "serviceType": "NA"
    },
    {
      "id": null,
      "name": null,
      "realm": "Unspecified",
      "serviceType": "NA"
    }
  ],
  "osu": {
    "externalOSU": {
      "provisioningProtocals": [
        "SOAP_XML",
        "OMA_DM"
      ],
      "osuServiceUrl": "https://ruckus.com",
      "osuNaiRealm": "realm1",
      "commonLanguageIcon": "Base64:imageData",
      "subscriptionDescriptions": [
        {
          "language": "English",
          "name": "ruckus"
        }
      ],
      "whitelistedDomains": [
        "google.com",
        "*.ruckus.com"
      ]
    }
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the Hotspot 2.0 identity provider profile",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the Hotspot 2.0 identity provider profile",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot 2.0 identity provider profile",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "realms" : {
            "description" : "Realms",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "name" : {
                        "description" : "Name of realm",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 243,
                        "pattern" : "^[!-~]([ -~]){0,241}[!-~]$"
                    },
                    "encoding" : {
                        "description" : "Encoding",
                        "type" : "string",
                        "enum" : [ "RFC4282", "UTF8" ]
                    },
                    "eapMethods" : {
                        "description" : "EAP methods",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "type" : {
                                    "description" : "EAP method type",
                                    "type" : "string",
                                    "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",
                                                "type" : "string",
                                                "enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
                                            },
                                            "type" : {
                                                "description" : "EAP auth type",
                                                "type" : "string"
                                            },
                                            "vendorId" : {
                                                "description" : "EAP auth vendor ID",
                                                "type" : [ "integer", "null" ],
                                                "format" : "int64",
                                                "minimum" : 0,
                                                "maximum" : 16777215
                                            },
                                            "vendorType" : {
                                                "description" : "EAP auth vendor type",
                                                "type" : [ "integer", "null" ],
                                                "format" : "int64",
                                                "minimum" : 0,
                                                "maximum" : 4294967295
                                            }
                                        },
                                        "required" : [ "info" ]
                                    }
                                }
                            },
                            "required" : [ "type" ]
                        }
                    }
                },
                "required" : [ "name", "encoding", "eapMethods" ]
            }
        },
        "plmns" : {
            "description" : "PLMNs",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "mcc" : {
                        "description" : "MCC",
                        "type" : "string",
                        "pattern" : "^[0-9]{3}$"
                    },
                    "mnc" : {
                        "description" : "MNC",
                        "type" : "string",
                        "pattern" : "^[0-9]{2,3}$"
                    }
                },
                "required" : [ "mcc", "mnc" ]
            }
        },
        "homeOis" : {
            "description" : "Home OIs",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "name" : {
                        "description" : "Name of the home OI",
                        "type" : "string",
                        "maxLength" : 255
                    },
                    "oi" : {
                        "description" : "Orgnization ID(3Hex or 5Hex)",
                        "type" : "string",
                        "pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
                    }
                },
                "required" : [ "name", "oi" ]
            }
        },
        "authentications" : {
            "description" : "Authentications",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Authentication id",
                        "type" : [ "string", "null" ]
                    },
                    "name" : {
                        "description" : "Authentication name",
                        "type" : [ "string", "null" ]
                    },
                    "realm" : {
                        "description" : "Authentication realm",
                        "type" : "string",
                        "maxLength" : 255,
                        "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
                    },
                    "serviceType" : {
                        "description" : "Authentication service type",
                        "type" : "string",
                        "enum" : [ "NA", "LOCAL_DB", "RADIUS", "GUEST" ]
                    },
                    "vlanId" : {
                        "description" : "Dynamic vlan ID",
                        "type" : [ "integer", "null" ],
                        "minimum" : 1,
                        "maximum" : 4094
                    }
                },
                "required" : [ "realm", "serviceType" ]
            }
        },
        "accountings" : {
            "description" : "Accountings",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Accounting id",
                        "type" : [ "string", "null" ]
                    },
                    "name" : {
                        "description" : "Accounting name",
                        "type" : [ "string", "null" ]
                    },
                    "realm" : {
                        "type" : "string",
                        "maxLength" : 255,
                        "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
                    },
                    "serviceType" : {
                        "description" : "Accounting service type",
                        "type" : "string",
                        "enum" : [ "NA", "RADIUS", "CGF" ]
                    }
                },
                "required" : [ "realm", "serviceType" ]
            }
        },
        "osu" : {
            "description" : "Online Signup & Provisioning",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "externalOSU" : {
                    "description" : "External online singup, required when type is External",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "provisioningProtocals" : {
                            "description" : "Provisioning protocal",
                            "type" : "array",
                            "items" : {
                                "type" : "string",
                                "enum" : [ "SOAP_XML", "OMA_DM" ]
                            }
                        },
                        "osuServiceUrl" : {
                            "description" : "External service URL, start with https://",
                            "type" : [ "string", "null" ],
                            "pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
                        },
                        "osuNaiRealm" : {
                            "description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
                            "type" : "string"
                        },
                        "singleSsidNai" : {
                            "type" : "string",
                            "maxLength" : 255
                        },
                        "commonLanguageIcon" : {
                            "description" : "The base64 encoded data of icon.",
                            "type" : "string"
                        },
                        "subscriptionDescriptions" : {
                            "description" : "Subscription descriptions",
                            "type" : "array",
                            "items" : {
                                "type" : "object",
                                "additionalProperties" : false,
                                "properties" : {
                                    "language" : {
                                        "description" : "Language of the friendly name",
                                        "type" : "string",
                                        "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                                    },
                                    "name" : {
                                        "description" : "Name of the friendly name",
                                        "type" : "string",
                                        "minLength" : 2,
                                        "maxLength" : 252
                                    },
                                    "description" : {
                                        "description" : "Description of the friendly name",
                                        "type" : [ "string", "null" ],
                                        "maxLength" : 64
                                    },
                                    "icon" : {
                                        "description" : "The binary data of icon, maximum size 65536",
                                        "type" : "string"
                                    }
                                },
                                "required" : [ "language", "name" ]
                            }
                        },
                        "whitelistedDomains" : {
                            "description" : "Whitelisted domains",
                            "type" : "array",
                            "items" : {
                                "description" : "Compare with FQDN, it could start with '*.'",
                                "type" : "string",
                                "pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
                            }
                        }
                    },
                    "required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ]
                }
            }
        },
        "domainId" : {
            "description" : "Domain Id",
            "type" : "string"
        },
        "createDateTime" : {
            "description" : "Timestamp of being created",
            "type" : "integer"
        },
        "modifiedDateTime" : {
            "description" : "Timestamp of being modified",
            "type" : "integer"
        },
        "creatorId" : {
            "description" : "Creator ID",
            "type" : "string"
        },
        "modifierId" : {
            "description" : "Modifier ID",
            "type" : "string"
        },
        "creatorUsername" : {
            "description" : "Creator Name",
            "type" : "string"
        },
        "modifierUsername" : {
            "description" : "Modifier Name",
            "type" : "string"
        }
    }
}

Retrieve List

GET/v11_1/profiles/hs20/identityproviders

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

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "b6df2529-db89-468e-aa57-94713f8af414",
      "name": "hs20Provider",
      "description": "",
      "realms": [
        {
          "name": "123",
          "encoding": "RFC4282",
          "eapMethods": [
            {
              "type": "NA",
              "authSettings": null
            },
            {
              "type": "NA",
              "authSettings": null
            },
            {
              "type": "NA",
              "authSettings": null
            },
            {
              "type": "NA",
              "authSettings": null
            }
          ]
        }
      ],
      "plmns": [
        {
          "mcc": "123",
          "mnc": "123"
        }
      ],
      "homeOis": null,
      "authentications": [
        {
          "id": null,
          "name": null,
          "realm": "No Match",
          "serviceType": "NA",
          "vlanId": null
        },
        {
          "id": null,
          "name": null,
          "realm": "Unspecified",
          "serviceType": "NA",
          "vlanId": null
        }
      ],
      "accountings": null,
      "osu": null,
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "createDateTime": 1486102871106,
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "admin",
      "modifiedDateTime": 1486102871106,
      "creatorUsername": "admin",
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    }
  ],
  "extra": {}
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "type" : "integer"
        },
        "hasMore" : {
            "type" : "boolean"
        },
        "firstIndex" : {
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Identifier of the Hotspot 2.0 identity provider profile",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the Hotspot 2.0 identity provider profile",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                    },
                    "description" : {
                        "description" : "Description of the Hotspot 2.0 identity provider profile",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64
                    },
                    "realms" : {
                        "description" : "Realms",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "name" : {
                                    "description" : "Name of realm",
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 243,
                                    "pattern" : "^[!-~]([ -~]){0,241}[!-~]$"
                                },
                                "encoding" : {
                                    "description" : "Encoding",
                                    "type" : "string",
                                    "enum" : [ "RFC4282", "UTF8" ]
                                },
                                "eapMethods" : {
                                    "description" : "EAP methods",
                                    "type" : "array",
                                    "items" : {
                                        "type" : "object",
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "type" : {
                                                "description" : "EAP method type",
                                                "type" : "string",
                                                "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",
                                                            "type" : "string",
                                                            "enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
                                                        },
                                                        "type" : {
                                                            "description" : "EAP auth type",
                                                            "type" : "string"
                                                        },
                                                        "vendorId" : {
                                                            "description" : "EAP auth vendor ID",
                                                            "type" : [ "integer", "null" ],
                                                            "format" : "int64",
                                                            "minimum" : 0,
                                                            "maximum" : 16777215
                                                        },
                                                        "vendorType" : {
                                                            "description" : "EAP auth vendor type",
                                                            "type" : [ "integer", "null" ],
                                                            "format" : "int64",
                                                            "minimum" : 0,
                                                            "maximum" : 4294967295
                                                        }
                                                    },
                                                    "required" : [ "info" ]
                                                }
                                            }
                                        },
                                        "required" : [ "type" ]
                                    }
                                }
                            },
                            "required" : [ "name", "encoding", "eapMethods" ]
                        }
                    },
                    "plmns" : {
                        "description" : "PLMNs",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "mcc" : {
                                    "description" : "MCC",
                                    "type" : "string",
                                    "pattern" : "^[0-9]{3}$"
                                },
                                "mnc" : {
                                    "description" : "MNC",
                                    "type" : "string",
                                    "pattern" : "^[0-9]{2,3}$"
                                }
                            },
                            "required" : [ "mcc", "mnc" ]
                        }
                    },
                    "homeOis" : {
                        "description" : "Home OIs",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "name" : {
                                    "description" : "Name of the home OI",
                                    "type" : "string",
                                    "maxLength" : 255
                                },
                                "oi" : {
                                    "description" : "Orgnization ID(3Hex or 5Hex)",
                                    "type" : "string",
                                    "pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
                                }
                            },
                            "required" : [ "name", "oi" ]
                        }
                    },
                    "authentications" : {
                        "description" : "Authentications",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "id" : {
                                    "description" : "Authentication id",
                                    "type" : [ "string", "null" ]
                                },
                                "name" : {
                                    "description" : "Authentication name",
                                    "type" : [ "string", "null" ]
                                },
                                "realm" : {
                                    "description" : "Authentication realm",
                                    "type" : "string",
                                    "maxLength" : 255,
                                    "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
                                },
                                "serviceType" : {
                                    "description" : "Authentication service type",
                                    "type" : "string",
                                    "enum" : [ "NA", "LOCAL_DB", "RADIUS", "GUEST" ]
                                },
                                "vlanId" : {
                                    "description" : "Dynamic vlan ID",
                                    "type" : [ "integer", "null" ],
                                    "minimum" : 1,
                                    "maximum" : 4094
                                }
                            },
                            "required" : [ "realm", "serviceType" ]
                        }
                    },
                    "accountings" : {
                        "description" : "Accountings",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "id" : {
                                    "description" : "Accounting id",
                                    "type" : [ "string", "null" ]
                                },
                                "name" : {
                                    "description" : "Accounting name",
                                    "type" : [ "string", "null" ]
                                },
                                "realm" : {
                                    "type" : "string",
                                    "maxLength" : 255,
                                    "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
                                },
                                "serviceType" : {
                                    "description" : "Accounting service type",
                                    "type" : "string",
                                    "enum" : [ "NA", "RADIUS", "CGF" ]
                                }
                            },
                            "required" : [ "realm", "serviceType" ]
                        }
                    },
                    "osu" : {
                        "description" : "Online Signup & Provisioning",
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "externalOSU" : {
                                "description" : "External online singup, required when type is External",
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "provisioningProtocals" : {
                                        "description" : "Provisioning protocal",
                                        "type" : "array",
                                        "items" : {
                                            "type" : "string",
                                            "enum" : [ "SOAP_XML", "OMA_DM" ]
                                        }
                                    },
                                    "osuServiceUrl" : {
                                        "description" : "External service URL, start with https://",
                                        "type" : [ "string", "null" ],
                                        "pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
                                    },
                                    "osuNaiRealm" : {
                                        "description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
                                        "type" : "string"
                                    },
                                    "singleSsidNai" : {
                                        "type" : "string",
                                        "maxLength" : 255
                                    },
                                    "commonLanguageIcon" : {
                                        "description" : "The base64 encoded data of icon.",
                                        "type" : "string"
                                    },
                                    "subscriptionDescriptions" : {
                                        "description" : "Subscription descriptions",
                                        "type" : "array",
                                        "items" : {
                                            "type" : "object",
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "language" : {
                                                    "description" : "Language of the friendly name",
                                                    "type" : "string",
                                                    "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                                                },
                                                "name" : {
                                                    "description" : "Name of the friendly name",
                                                    "type" : "string",
                                                    "minLength" : 2,
                                                    "maxLength" : 252
                                                },
                                                "description" : {
                                                    "description" : "Description of the friendly name",
                                                    "type" : [ "string", "null" ],
                                                    "maxLength" : 64
                                                },
                                                "icon" : {
                                                    "description" : "The binary data of icon, maximum size 65536",
                                                    "type" : "string"
                                                }
                                            },
                                            "required" : [ "language", "name" ]
                                        }
                                    },
                                    "whitelistedDomains" : {
                                        "description" : "Whitelisted domains",
                                        "type" : "array",
                                        "items" : {
                                            "description" : "Compare with FQDN, it could start with '*.'",
                                            "type" : "string",
                                            "pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
                                        }
                                    }
                                },
                                "required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ]
                            }
                        }
                    },
                    "domainId" : {
                        "description" : "Domain Id",
                        "type" : "string"
                    },
                    "createDateTime" : {
                        "description" : "Timestamp of being created",
                        "type" : "integer"
                    },
                    "modifiedDateTime" : {
                        "description" : "Timestamp of being modified",
                        "type" : "integer"
                    },
                    "creatorId" : {
                        "description" : "Creator ID",
                        "type" : "string"
                    },
                    "modifierId" : {
                        "description" : "Modifier ID",
                        "type" : "string"
                    },
                    "creatorUsername" : {
                        "description" : "Creator Name",
                        "type" : "string"
                    },
                    "modifierUsername" : {
                        "description" : "Modifier Name",
                        "type" : "string"
                    }
                }
            }
        },
        "extra" : {
            "type" : "object",
            "properties" : {
                "rbacMetadata" : {
                    "type" : "array",
                    "items" : {
                        "additionalProperties" : {
                            "type" : "string"
                        },
                        "properties" : { }
                    }
                }
            }
        }
    }
}

Query hotspot 2.0 identity provider

POST/v11_1/profiles/hs20/identityproviders/query

Query hotspot 2.0 identity providers. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "b6df2529-db89-468e-aa57-94713f8af414",
      "name": "hs20Provider",
      "description": "",
      "realms": [
        {
          "name": "123",
          "encoding": "RFC4282",
          "eapMethods": [
            {
              "type": "NA",
              "authSettings": null
            },
            {
              "type": "NA",
              "authSettings": null
            },
            {
              "type": "NA",
              "authSettings": null
            },
            {
              "type": "NA",
              "authSettings": null
            }
          ]
        }
      ],
      "plmns": [
        {
          "mcc": "123",
          "mnc": "123"
        }
      ],
      "homeOis": null,
      "authentications": [
        {
          "id": null,
          "name": null,
          "realm": "No Match",
          "serviceType": "NA",
          "vlanId": null
        },
        {
          "id": null,
          "name": null,
          "realm": "Unspecified",
          "serviceType": "NA",
          "vlanId": null
        }
      ],
      "accountings": null,
      "osu": null,
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "createDateTime": 1486102871106,
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "admin",
      "modifiedDateTime": 1486102871106,
      "creatorUsername": "admin",
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    }
  ],
  "extra": {}
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "type" : "integer"
        },
        "hasMore" : {
            "type" : "boolean"
        },
        "firstIndex" : {
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Identifier of the Hotspot 2.0 identity provider profile",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the Hotspot 2.0 identity provider profile",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                    },
                    "description" : {
                        "description" : "Description of the Hotspot 2.0 identity provider profile",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64
                    },
                    "realms" : {
                        "description" : "Realms",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "name" : {
                                    "description" : "Name of realm",
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 243,
                                    "pattern" : "^[!-~]([ -~]){0,241}[!-~]$"
                                },
                                "encoding" : {
                                    "description" : "Encoding",
                                    "type" : "string",
                                    "enum" : [ "RFC4282", "UTF8" ]
                                },
                                "eapMethods" : {
                                    "description" : "EAP methods",
                                    "type" : "array",
                                    "items" : {
                                        "type" : "object",
                                        "additionalProperties" : false,
                                        "properties" : {
                                            "type" : {
                                                "description" : "EAP method type",
                                                "type" : "string",
                                                "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",
                                                            "type" : "string",
                                                            "enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
                                                        },
                                                        "type" : {
                                                            "description" : "EAP auth type",
                                                            "type" : "string"
                                                        },
                                                        "vendorId" : {
                                                            "description" : "EAP auth vendor ID",
                                                            "type" : [ "integer", "null" ],
                                                            "format" : "int64",
                                                            "minimum" : 0,
                                                            "maximum" : 16777215
                                                        },
                                                        "vendorType" : {
                                                            "description" : "EAP auth vendor type",
                                                            "type" : [ "integer", "null" ],
                                                            "format" : "int64",
                                                            "minimum" : 0,
                                                            "maximum" : 4294967295
                                                        }
                                                    },
                                                    "required" : [ "info" ]
                                                }
                                            }
                                        },
                                        "required" : [ "type" ]
                                    }
                                }
                            },
                            "required" : [ "name", "encoding", "eapMethods" ]
                        }
                    },
                    "plmns" : {
                        "description" : "PLMNs",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "mcc" : {
                                    "description" : "MCC",
                                    "type" : "string",
                                    "pattern" : "^[0-9]{3}$"
                                },
                                "mnc" : {
                                    "description" : "MNC",
                                    "type" : "string",
                                    "pattern" : "^[0-9]{2,3}$"
                                }
                            },
                            "required" : [ "mcc", "mnc" ]
                        }
                    },
                    "homeOis" : {
                        "description" : "Home OIs",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "name" : {
                                    "description" : "Name of the home OI",
                                    "type" : "string",
                                    "maxLength" : 255
                                },
                                "oi" : {
                                    "description" : "Orgnization ID(3Hex or 5Hex)",
                                    "type" : "string",
                                    "pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
                                }
                            },
                            "required" : [ "name", "oi" ]
                        }
                    },
                    "authentications" : {
                        "description" : "Authentications",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "id" : {
                                    "description" : "Authentication id",
                                    "type" : [ "string", "null" ]
                                },
                                "name" : {
                                    "description" : "Authentication name",
                                    "type" : [ "string", "null" ]
                                },
                                "realm" : {
                                    "description" : "Authentication realm",
                                    "type" : "string",
                                    "maxLength" : 255,
                                    "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
                                },
                                "serviceType" : {
                                    "description" : "Authentication service type",
                                    "type" : "string",
                                    "enum" : [ "NA", "LOCAL_DB", "RADIUS", "GUEST" ]
                                },
                                "vlanId" : {
                                    "description" : "Dynamic vlan ID",
                                    "type" : [ "integer", "null" ],
                                    "minimum" : 1,
                                    "maximum" : 4094
                                }
                            },
                            "required" : [ "realm", "serviceType" ]
                        }
                    },
                    "accountings" : {
                        "description" : "Accountings",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "id" : {
                                    "description" : "Accounting id",
                                    "type" : [ "string", "null" ]
                                },
                                "name" : {
                                    "description" : "Accounting name",
                                    "type" : [ "string", "null" ]
                                },
                                "realm" : {
                                    "type" : "string",
                                    "maxLength" : 255,
                                    "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
                                },
                                "serviceType" : {
                                    "description" : "Accounting service type",
                                    "type" : "string",
                                    "enum" : [ "NA", "RADIUS", "CGF" ]
                                }
                            },
                            "required" : [ "realm", "serviceType" ]
                        }
                    },
                    "osu" : {
                        "description" : "Online Signup & Provisioning",
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "externalOSU" : {
                                "description" : "External online singup, required when type is External",
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "provisioningProtocals" : {
                                        "description" : "Provisioning protocal",
                                        "type" : "array",
                                        "items" : {
                                            "type" : "string",
                                            "enum" : [ "SOAP_XML", "OMA_DM" ]
                                        }
                                    },
                                    "osuServiceUrl" : {
                                        "description" : "External service URL, start with https://",
                                        "type" : [ "string", "null" ],
                                        "pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
                                    },
                                    "osuNaiRealm" : {
                                        "description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
                                        "type" : "string"
                                    },
                                    "singleSsidNai" : {
                                        "type" : "string",
                                        "maxLength" : 255
                                    },
                                    "commonLanguageIcon" : {
                                        "description" : "The base64 encoded data of icon.",
                                        "type" : "string"
                                    },
                                    "subscriptionDescriptions" : {
                                        "description" : "Subscription descriptions",
                                        "type" : "array",
                                        "items" : {
                                            "type" : "object",
                                            "additionalProperties" : false,
                                            "properties" : {
                                                "language" : {
                                                    "description" : "Language of the friendly name",
                                                    "type" : "string",
                                                    "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                                                },
                                                "name" : {
                                                    "description" : "Name of the friendly name",
                                                    "type" : "string",
                                                    "minLength" : 2,
                                                    "maxLength" : 252
                                                },
                                                "description" : {
                                                    "description" : "Description of the friendly name",
                                                    "type" : [ "string", "null" ],
                                                    "maxLength" : 64
                                                },
                                                "icon" : {
                                                    "description" : "The binary data of icon, maximum size 65536",
                                                    "type" : "string"
                                                }
                                            },
                                            "required" : [ "language", "name" ]
                                        }
                                    },
                                    "whitelistedDomains" : {
                                        "description" : "Whitelisted domains",
                                        "type" : "array",
                                        "items" : {
                                            "description" : "Compare with FQDN, it could start with '*.'",
                                            "type" : "string",
                                            "pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
                                        }
                                    }
                                },
                                "required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ]
                            }
                        }
                    },
                    "domainId" : {
                        "description" : "Domain Id",
                        "type" : "string"
                    },
                    "createDateTime" : {
                        "description" : "Timestamp of being created",
                        "type" : "integer"
                    },
                    "modifiedDateTime" : {
                        "description" : "Timestamp of being modified",
                        "type" : "integer"
                    },
                    "creatorId" : {
                        "description" : "Creator ID",
                        "type" : "string"
                    },
                    "modifierId" : {
                        "description" : "Modifier ID",
                        "type" : "string"
                    },
                    "creatorUsername" : {
                        "description" : "Creator Name",
                        "type" : "string"
                    },
                    "modifierUsername" : {
                        "description" : "Modifier Name",
                        "type" : "string"
                    }
                }
            }
        },
        "extra" : {
            "type" : "object",
            "properties" : {
                "rbacMetadata" : {
                    "type" : "array",
                    "items" : {
                        "additionalProperties" : {
                            "type" : "string"
                        },
                        "properties" : { }
                    }
                }
            }
        }
    }
}

Create

POST/v11_1/profiles/hs20/identityproviders

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

Request
HideShow
Body
{
  "id": "1fb20eaf-7b9b-40c7-8b9b-7d69d6165176",
  "name": "hs20IdentithexternalOSU",
  "description": "",
  "realms": [
    {
      "name": "reamlll",
      "encoding": "RFC4282",
      "eapMethods": [
        {
          "type": "NA",
          "authSettings": null
        },
        {
          "type": "NA",
          "authSettings": null
        },
        {
          "type": "NA",
          "authSettings": null
        },
        {
          "type": "NA",
          "authSettings": null
        }
      ]
    }
  ],
  "plmns": [
    {
      "mcc": "866",
      "mnc": "02"
    }
  ],
  "homeOis": [
    {
      "name": "enter_name",
      "oi": "999aaa"
    }
  ],
  "authentications": [
    {
      "id": "868b0b20-8598-11e4-8acc-08002716c79f",
      "name": "globalRadius",
      "realm": "globalAuth",
      "serviceType": "RADIUS",
      "vlanId": 23
    },
    {
      "id": null,
      "name": null,
      "realm": "No Match",
      "serviceType": "NA",
      "vlanId": null
    },
    {
      "id": null,
      "name": null,
      "realm": "Unspecified",
      "serviceType": "NA",
      "vlanId": null
    }
  ],
  "accountings": [
    {
      "id": "789ff6b0-8598-11e4-8acc-08002716c79f",
      "name": "globalRadiusAcct",
      "realm": "globalAcct",
      "serviceType": "RADIUS"
    },
    {
      "id": null,
      "name": null,
      "realm": "No Match",
      "serviceType": "NA"
    },
    {
      "id": null,
      "name": null,
      "realm": "Unspecified",
      "serviceType": "NA"
    }
  ],
  "osu": {
    "externalOSU": {
      "provisioningProtocals": [
        "SOAP_XML",
        "OMA_DM"
      ],
      "osuServiceUrl": "https://ruckus.com",
      "osuNaiRealm": "realm1",
      "commonLanguageIcon": "Base64:imageData",
      "subscriptionDescriptions": [
        {
          "language": "English",
          "name": "ruckus"
        }
      ],
      "whitelistedDomains": [
        "google.com",
        "*.ruckus.com"
      ]
    }
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the Hotspot 2.0 identity provider profile",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the Hotspot 2.0 identity provider profile",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot 2.0 identity provider profile",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "realms" : {
            "description" : "Realms",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "name" : {
                        "description" : "Name of realm",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 243,
                        "pattern" : "^[!-~]([ -~]){0,241}[!-~]$"
                    },
                    "encoding" : {
                        "description" : "Encoding",
                        "type" : "string",
                        "enum" : [ "RFC4282", "UTF8" ]
                    },
                    "eapMethods" : {
                        "description" : "EAP methods",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "type" : {
                                    "description" : "EAP method type",
                                    "type" : "string",
                                    "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",
                                                "type" : "string",
                                                "enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
                                            },
                                            "type" : {
                                                "description" : "EAP auth type",
                                                "type" : "string"
                                            },
                                            "vendorId" : {
                                                "description" : "EAP auth vendor ID",
                                                "type" : [ "integer", "null" ],
                                                "format" : "int64",
                                                "minimum" : 0,
                                                "maximum" : 16777215
                                            },
                                            "vendorType" : {
                                                "description" : "EAP auth vendor type",
                                                "type" : [ "integer", "null" ],
                                                "format" : "int64",
                                                "minimum" : 0,
                                                "maximum" : 4294967295
                                            }
                                        },
                                        "required" : [ "info" ]
                                    }
                                }
                            },
                            "required" : [ "type" ]
                        }
                    }
                },
                "required" : [ "name", "encoding", "eapMethods" ]
            }
        },
        "plmns" : {
            "description" : "PLMNs",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "mcc" : {
                        "description" : "MCC",
                        "type" : "string",
                        "pattern" : "^[0-9]{3}$"
                    },
                    "mnc" : {
                        "description" : "MNC",
                        "type" : "string",
                        "pattern" : "^[0-9]{2,3}$"
                    }
                },
                "required" : [ "mcc", "mnc" ]
            }
        },
        "homeOis" : {
            "description" : "Home OIs",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "name" : {
                        "description" : "Name of the home OI",
                        "type" : "string",
                        "maxLength" : 255
                    },
                    "oi" : {
                        "description" : "Orgnization ID(3Hex or 5Hex)",
                        "type" : "string",
                        "pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
                    }
                },
                "required" : [ "name", "oi" ]
            }
        },
        "authentications" : {
            "description" : "Authentications",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Authentication id",
                        "type" : [ "string", "null" ]
                    },
                    "name" : {
                        "description" : "Authentication name",
                        "type" : [ "string", "null" ]
                    },
                    "realm" : {
                        "description" : "Authentication realm",
                        "type" : "string",
                        "maxLength" : 255,
                        "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
                    },
                    "serviceType" : {
                        "description" : "Authentication service type",
                        "type" : "string",
                        "enum" : [ "NA", "LOCAL_DB", "RADIUS", "GUEST" ]
                    },
                    "vlanId" : {
                        "description" : "Dynamic vlan ID",
                        "type" : [ "integer", "null" ],
                        "minimum" : 1,
                        "maximum" : 4094
                    }
                },
                "required" : [ "realm", "serviceType" ]
            }
        },
        "accountings" : {
            "description" : "Accountings",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Accounting id",
                        "type" : [ "string", "null" ]
                    },
                    "name" : {
                        "description" : "Accounting name",
                        "type" : [ "string", "null" ]
                    },
                    "realm" : {
                        "type" : "string",
                        "maxLength" : 255,
                        "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
                    },
                    "serviceType" : {
                        "description" : "Accounting service type",
                        "type" : "string",
                        "enum" : [ "NA", "RADIUS", "CGF" ]
                    }
                },
                "required" : [ "realm", "serviceType" ]
            }
        },
        "osu" : {
            "description" : "Online Signup & Provisioning",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "externalOSU" : {
                    "description" : "External online singup, required when type is External",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "provisioningProtocals" : {
                            "description" : "Provisioning protocal",
                            "type" : "array",
                            "items" : {
                                "type" : "string",
                                "enum" : [ "SOAP_XML", "OMA_DM" ]
                            }
                        },
                        "osuServiceUrl" : {
                            "description" : "External service URL, start with https://",
                            "type" : [ "string", "null" ],
                            "pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
                        },
                        "osuNaiRealm" : {
                            "description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
                            "type" : "string"
                        },
                        "singleSsidNai" : {
                            "type" : "string",
                            "maxLength" : 255
                        },
                        "commonLanguageIcon" : {
                            "description" : "The base64 encoded data of icon.",
                            "type" : "string"
                        },
                        "subscriptionDescriptions" : {
                            "description" : "Subscription descriptions",
                            "type" : "array",
                            "items" : {
                                "type" : "object",
                                "additionalProperties" : false,
                                "properties" : {
                                    "language" : {
                                        "description" : "Language of the friendly name",
                                        "type" : "string",
                                        "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                                    },
                                    "name" : {
                                        "description" : "Name of the friendly name",
                                        "type" : "string",
                                        "minLength" : 2,
                                        "maxLength" : 252
                                    },
                                    "description" : {
                                        "description" : "Description of the friendly name",
                                        "type" : [ "string", "null" ],
                                        "maxLength" : 64
                                    },
                                    "icon" : {
                                        "description" : "The binary data of icon, maximum size 65536",
                                        "type" : "string"
                                    }
                                },
                                "required" : [ "language", "name" ]
                            }
                        },
                        "whitelistedDomains" : {
                            "description" : "Whitelisted domains",
                            "type" : "array",
                            "items" : {
                                "description" : "Compare with FQDN, it could start with '*.'",
                                "type" : "string",
                                "pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
                            }
                        }
                    },
                    "required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ]
                }
            }
        },
        "domainId" : {
            "description" : "Domain Id",
            "type" : "string"
        },
        "createDateTime" : {
            "description" : "Timestamp of being created",
            "type" : "integer"
        },
        "modifiedDateTime" : {
            "description" : "Timestamp of being modified",
            "type" : "integer"
        },
        "creatorId" : {
            "description" : "Creator ID",
            "type" : "string"
        },
        "modifierId" : {
            "description" : "Modifier ID",
            "type" : "string"
        },
        "creatorUsername" : {
            "description" : "Creator Name",
            "type" : "string"
        },
        "modifierUsername" : {
            "description" : "Modifier Name",
            "type" : "string"
        }
    }
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v11_1/profiles/hs20/identityproviders/{id}

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

Request
HideShow
Body
{
  "id": "1fb20eaf-7b9b-40c7-8b9b-7d69d6165176",
  "name": "hs20IdentithexternalOSU",
  "description": "",
  "realms": [
    {
      "name": "reamlll",
      "encoding": "RFC4282",
      "eapMethods": [
        {
          "type": "NA",
          "authSettings": null
        },
        {
          "type": "NA",
          "authSettings": null
        },
        {
          "type": "NA",
          "authSettings": null
        },
        {
          "type": "NA",
          "authSettings": null
        }
      ]
    }
  ],
  "plmns": [
    {
      "mcc": "866",
      "mnc": "02"
    }
  ],
  "homeOis": [
    {
      "name": "enter_name",
      "oi": "999aaa"
    }
  ],
  "authentications": [
    {
      "id": "868b0b20-8598-11e4-8acc-08002716c79f",
      "name": "globalRadius",
      "realm": "globalAuth",
      "serviceType": "RADIUS",
      "vlanId": 23
    },
    {
      "id": null,
      "name": null,
      "realm": "No Match",
      "serviceType": "NA",
      "vlanId": null
    },
    {
      "id": null,
      "name": null,
      "realm": "Unspecified",
      "serviceType": "NA",
      "vlanId": null
    }
  ],
  "accountings": [
    {
      "id": "789ff6b0-8598-11e4-8acc-08002716c79f",
      "name": "globalRadiusAcct",
      "realm": "globalAcct",
      "serviceType": "RADIUS"
    },
    {
      "id": null,
      "name": null,
      "realm": "No Match",
      "serviceType": "NA"
    },
    {
      "id": null,
      "name": null,
      "realm": "Unspecified",
      "serviceType": "NA"
    }
  ],
  "osu": {
    "externalOSU": {
      "provisioningProtocals": [
        "SOAP_XML",
        "OMA_DM"
      ],
      "osuServiceUrl": "https://ruckus.com",
      "osuNaiRealm": "realm1",
      "commonLanguageIcon": "Base64:imageData",
      "subscriptionDescriptions": [
        {
          "language": "English",
          "name": "ruckus"
        }
      ],
      "whitelistedDomains": [
        "google.com",
        "*.ruckus.com"
      ]
    }
  }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the Hotspot 2.0 identity provider profile",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the Hotspot 2.0 identity provider profile",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot 2.0 identity provider profile",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "realms" : {
            "description" : "Realms",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "name" : {
                        "description" : "Name of realm",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 243,
                        "pattern" : "^[!-~]([ -~]){0,241}[!-~]$"
                    },
                    "encoding" : {
                        "description" : "Encoding",
                        "type" : "string",
                        "enum" : [ "RFC4282", "UTF8" ]
                    },
                    "eapMethods" : {
                        "description" : "EAP methods",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "type" : {
                                    "description" : "EAP method type",
                                    "type" : "string",
                                    "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",
                                                "type" : "string",
                                                "enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
                                            },
                                            "type" : {
                                                "description" : "EAP auth type",
                                                "type" : "string"
                                            },
                                            "vendorId" : {
                                                "description" : "EAP auth vendor ID",
                                                "type" : [ "integer", "null" ],
                                                "format" : "int64",
                                                "minimum" : 0,
                                                "maximum" : 16777215
                                            },
                                            "vendorType" : {
                                                "description" : "EAP auth vendor type",
                                                "type" : [ "integer", "null" ],
                                                "format" : "int64",
                                                "minimum" : 0,
                                                "maximum" : 4294967295
                                            }
                                        },
                                        "required" : [ "info" ]
                                    }
                                }
                            },
                            "required" : [ "type" ]
                        }
                    }
                },
                "required" : [ "name", "encoding", "eapMethods" ]
            }
        },
        "plmns" : {
            "description" : "PLMNs",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "mcc" : {
                        "description" : "MCC",
                        "type" : "string",
                        "pattern" : "^[0-9]{3}$"
                    },
                    "mnc" : {
                        "description" : "MNC",
                        "type" : "string",
                        "pattern" : "^[0-9]{2,3}$"
                    }
                },
                "required" : [ "mcc", "mnc" ]
            }
        },
        "homeOis" : {
            "description" : "Home OIs",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "name" : {
                        "description" : "Name of the home OI",
                        "type" : "string",
                        "maxLength" : 255
                    },
                    "oi" : {
                        "description" : "Orgnization ID(3Hex or 5Hex)",
                        "type" : "string",
                        "pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
                    }
                },
                "required" : [ "name", "oi" ]
            }
        },
        "authentications" : {
            "description" : "Authentications",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Authentication id",
                        "type" : [ "string", "null" ]
                    },
                    "name" : {
                        "description" : "Authentication name",
                        "type" : [ "string", "null" ]
                    },
                    "realm" : {
                        "description" : "Authentication realm",
                        "type" : "string",
                        "maxLength" : 255,
                        "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
                    },
                    "serviceType" : {
                        "description" : "Authentication service type",
                        "type" : "string",
                        "enum" : [ "NA", "LOCAL_DB", "RADIUS", "GUEST" ]
                    },
                    "vlanId" : {
                        "description" : "Dynamic vlan ID",
                        "type" : [ "integer", "null" ],
                        "minimum" : 1,
                        "maximum" : 4094
                    }
                },
                "required" : [ "realm", "serviceType" ]
            }
        },
        "accountings" : {
            "description" : "Accountings",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Accounting id",
                        "type" : [ "string", "null" ]
                    },
                    "name" : {
                        "description" : "Accounting name",
                        "type" : [ "string", "null" ]
                    },
                    "realm" : {
                        "type" : "string",
                        "maxLength" : 255,
                        "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
                    },
                    "serviceType" : {
                        "description" : "Accounting service type",
                        "type" : "string",
                        "enum" : [ "NA", "RADIUS", "CGF" ]
                    }
                },
                "required" : [ "realm", "serviceType" ]
            }
        },
        "osu" : {
            "description" : "Online Signup & Provisioning",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "externalOSU" : {
                    "description" : "External online singup, required when type is External",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "provisioningProtocals" : {
                            "description" : "Provisioning protocal",
                            "type" : "array",
                            "items" : {
                                "type" : "string",
                                "enum" : [ "SOAP_XML", "OMA_DM" ]
                            }
                        },
                        "osuServiceUrl" : {
                            "description" : "External service URL, start with https://",
                            "type" : [ "string", "null" ],
                            "pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$"
                        },
                        "osuNaiRealm" : {
                            "description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
                            "type" : "string"
                        },
                        "singleSsidNai" : {
                            "type" : "string",
                            "maxLength" : 255
                        },
                        "commonLanguageIcon" : {
                            "description" : "The base64 encoded data of icon.",
                            "type" : "string"
                        },
                        "subscriptionDescriptions" : {
                            "description" : "Subscription descriptions",
                            "type" : "array",
                            "items" : {
                                "type" : "object",
                                "additionalProperties" : false,
                                "properties" : {
                                    "language" : {
                                        "description" : "Language of the friendly name",
                                        "type" : "string",
                                        "enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish", "eng", "chi", "cze", "dan", "dut", "fre", "ger", "jpn", "kor", "spa", "swe", "tur" ]
                                    },
                                    "name" : {
                                        "description" : "Name of the friendly name",
                                        "type" : "string",
                                        "minLength" : 2,
                                        "maxLength" : 252
                                    },
                                    "description" : {
                                        "description" : "Description of the friendly name",
                                        "type" : [ "string", "null" ],
                                        "maxLength" : 64
                                    },
                                    "icon" : {
                                        "description" : "The binary data of icon, maximum size 65536",
                                        "type" : "string"
                                    }
                                },
                                "required" : [ "language", "name" ]
                            }
                        },
                        "whitelistedDomains" : {
                            "description" : "Whitelisted domains",
                            "type" : "array",
                            "items" : {
                                "description" : "Compare with FQDN, it could start with '*.'",
                                "type" : "string",
                                "pattern" : "^((?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-zA-Z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,63})$"
                            }
                        }
                    },
                    "required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ]
                }
            }
        },
        "domainId" : {
            "description" : "Domain Id",
            "type" : "string"
        },
        "createDateTime" : {
            "description" : "Timestamp of being created",
            "type" : "integer"
        },
        "modifiedDateTime" : {
            "description" : "Timestamp of being modified",
            "type" : "integer"
        },
        "creatorId" : {
            "description" : "Creator ID",
            "type" : "string"
        },
        "modifierId" : {
            "description" : "Modifier ID",
            "type" : "string"
        },
        "creatorUsername" : {
            "description" : "Creator Name",
            "type" : "string"
        },
        "modifierUsername" : {
            "description" : "Modifier Name",
            "type" : "string"
        }
    }
}
Response  204

Disable Accountings

DELETE/v11_1/profiles/hs20/identityproviders/{id}/accountings

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

Response  204

Disable Online Signup & Provisioning

DELETE/v11_1/profiles/hs20/identityproviders/{id}/osu

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

Response  204

Delete

DELETE/v11_1/profiles/hs20/identityproviders/{id}

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

Response  204

Delete

DELETE/v11_1/profiles/hs20/identityproviders

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

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Certificate

Retrieve Certificate

GET/v11_1/certstore/certificate/{id}

Use this API command to retrieve an installed certificate.

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

Retrieve Certificate Setting

GET/v11_1/certstore/setting

Use this API command to retrieve certificate setting.

Response  200
HideShow
Body
{
  "serviceCertificates": [
    {
      "service": "MANAGEMENT_WEB",
      "certificate": {
        "id": "dc9696f0-e43e-11e5-a304-525400fbb1bb",
        "name": "newcert"
      }
    },
    {
      "service": "AP_PORTAL",
      "certificate": {
        "id": "dc9696f0-e43e-11e5-a304-525400fbb1bb",
        "name": "newcert"
      }
    },
    {
      "service": "HOTSPOT",
      "certificate": {
        "id": "11111111-1111-1111-1111-111111111111",
        "name": "Default Certificate"
      }
    },
    {
      "service": "COMMUNICATOR",
      "certificate": {
        "id": "11111111-1111-1111-1111-111111111111",
        "name": "Default Certificate"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "serviceCertificates": {
      "description": "Certificate Setting of the service",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "service": {
            "description": "the service",
            "type": "string",
            "enum": [
              "MANAGEMENT_WEB",
              "AP_PORTAL",
              "HOTSPOT",
              "COMMUNICATOR"
            ]
          },
          "certificate": {
            "description": "certificate of the service",
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "service"
        ]
      }
    }
  }
}

Retrieve CSR List

GET/v11_1/certstore/csr

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

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "privateKey1",
      "name": "privateKey1",
      "description": "private key1 description"
    },
    {
      "id": "privateKey2",
      "name": "privateKey2",
      "description": "private key2 description"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the certificates signing request",
            "type": "string"
          },
          "name": {
            "description": "Name of the certificates signing request",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the certificates signing request",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          }
        }
      }
    }
  }
}

Retrieve CSR

GET/v11_1/certstore/csr/{id}

Use this API command to retrieve a certificates signing request.

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

Retrieve Trusted CA Chain Certificates List

GET/v11_1/certstore/trustedCAChainCert

Use this API command to retrieve list of installed trusted CA chain certificates.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
    "totalCount" : 2,
    "hasMore" : false,
    "firstIndex" : 0,
    "list" : [ {
        "id" : "rootCertificate",
        "name" : "rootCertificate",
        "description" : "root certificate description",
        "interCertData" : [ "intermediateCertifcateData1", "intermediateCertifcateData2" ],
        "rootCertData" : "rootCertificateData"
    }, {
        "id" : "hs20Certificate",
        "name" : "hs20Certificate",
        "description" : "Hotspot20 certificate description",
        "information" : "\n\n-----BEGIN INTERMEDIATE CERTIFICATE #1 -----\n[\n[\n  Version: V3\n  Subject: CN=Verizon Hotspot 2.0 Intermediate CA, OU=Cybertrust, O=Verizon Enterprise Solutions, L=Amsterdam, C=NL\n  Signature Algorithm: SHA256withRSA, OID = 1.2.840.113549.1.1.11\n\n  Key:  Sun RSA public key, 2048 bits\n  modulus: 23617561117988111216066421024092057505707971583866555863467960236740199253262690005512455723125315310387461393165651970748842793301611918034442594711994634192423187372806761353350113250438225110389282744014438367665821734885051972120241834680068338044857354569175288575440030311710708015575344394358723355054477230016829047631782713506713276018655043123697918236044268053319322704458844413722254348232276124596584542075041243826757391193963245254337908100807532825175242207243382889107249881414575066011404307393987338973084479538528154253484161987803827349486330380817232385299053004582804890215693233201596774334823\n  public exponent: 65537\n  Validity: [From: Mon Aug 11 18:44:39 UTC 2014,\n               To: Sun Aug 11 18:44:09 UTC 2024]\n  Issuer: CN=Hotspot 2.0 Trust Root CA - 02, O=WFA Hotspot 2.0, C=US\n  SerialNumber: [    cb]\n\nCertificate Extensions: 6\n[1]: ObjectId: 1.3.6.1.5.5.7.1.1 Criticality=false\nAuthorityInfoAccess [\n  [\n   accessMethod: ocsp\n   accessLocation: URIName: http://ocsp.omniroot.com/hotspotroot\n]\n]\n\n[2]: ObjectId: 2.5.29.35 Criticality=false\nAuthorityKeyIdentifier [\nKeyIdentifier [\n0000: E4 2F 5C D4 E3 2C 07 EF   CC 3B 09 7D 38 A1 B6 0F  ./\..,...;..8...\n0010: F5 D2 C2 B5                                        ....\n]\n]\n\n[3]: ObjectId: 2.5.29.19 Criticality=true\nBasicConstraints:[\n  CA:true\n  PathLen:0\n]\n\n[4]: ObjectId: 2.5.29.32 Criticality=false\nCertificatePolicies [\n  [CertificatePolicyId: [1.3.6.1.4.1.6334.1.600.1]\n[PolicyQualifierInfo: [\n  qualifierID: 1.3.6.1.5.5.7.2.1\n  qualifier: 0000: 16 27 20 68 74 74 70 73   3A 2F 2F 73 65 63 75 72  .' https://secur\n0010: 65 2E 6F 6D 6E 69 72 6F   6F 74 2E 63 6F 6D 2F 72  e.omniroot.com/r\n0020: 65 70 6F 73 69 74 6F 72   79                       epository\n\n]]  ]\n]\n\n[5]: ObjectId: 2.5.29.15 Criticality=true\nKeyUsage [\n  DigitalSignature\n  Non_repudiation\n  Key_CertSign\n  Crl_Sign\n]\n\n[6]: ObjectId: 2.5.29.14 Criticality=false\nSubjectKeyIdentifier [\nKeyIdentifier [\n0000: 5C 5D 9D B6 A0 47 88 1B   61 40 E1 B7 E6 42 CE 81  \][email protected]..\n0010: 2F 44 6E 40                                        /Dn@\n]\n]\n\n]\n  Algorithm: [SHA256withRSA]\n  Signature:\n0000: 86 44 36 50 5A F2 92 22   B1 CD F1 3F 76 46 D0 F2  .D6PZ..\"...?vF..\n0010: 21 71 E8 7C CD 15 67 69   F0 0A AE 07 34 61 B4 2F  !q....gi....4a./\n0020: 9A 7F E1 70 5C 87 BA F5   62 6C D9 C9 C9 4D 38 15  ...p\...bl...M8.\n0030: C2 9A 3F 1A 9E 94 A3 2E   EB 77 76 D7 46 75 0F EC  ..?......wv.Fu..\n0040: C5 CF 38 EB 52 4E FC 3D   65 05 45 40 8B 17 12 87  ..8.RN.=e.E@....\n0050: FE E3 CB 47 46 2F DC 22   00 9D C6 20 05 53 11 0A  ...GF/.\"... .S..\n0060: 4B 1B 01 4C 39 2F DA 4B   4F FF 65 06 39 36 05 82  K..L9/.KO.e.96..\n0070: 81 6F 9E E5 FB 9B AF 81   91 75 63 AF EC BA 7E D8  .o.......uc.....\n0080: 99 D2 B1 FA E6 34 68 DD   03 6F 9A FE FA F8 E7 12  .....4h..o......\n0090: D0 7E A8 34 2B 2F E2 A6   9D A9 84 38 4D 8F 58 14  ...4+/.....8M.X.\n00A0: FD A3 02 04 E9 81 74 BD   E6 14 F7 69 32 E9 CF 17  ......t....i2...\n00B0: 7A 45 C7 0F F8 22 A8 7E   A5 8A 26 8F 3B 06 45 86  zE...\"....&.;.E.\n00C0: 09 E8 D6 AB 35 E8 C1 E2   EC F2 A0 B6 8F 39 70 D8  ....5........9p.\n00D0: AF 71 80 2C E7 45 DE 6A   78 5A 98 B7 72 CD 73 B8  .q.,.E.jxZ..r.s.\n00E0: 33 4F 56 C7 95 58 13 B4   23 8D CC F1 BC 72 2A ED  3OV..X..#....r*.\n00F0: 70 20 CD 5F DD 47 99 BD   E0 46 8E E2 37 86 0B F9  p ._.G...F..7...\n0100: 47 A4 5A EC F5 A4 93 C7   F4 C3 44 86 FA 00 C5 D1  G.Z.......D.....\n0110: FA C3 D8 72 1E 1E 66 3B   9E 44 51 0C 5B 41 29 AF  ...r..f;.DQ.[A).\n0120: A1 73 9B 4E 27 BF 91 22   97 C6 B1 EC E8 48 A5 F5  .s.N'..\".....H..\n0130: EF 52 21 58 57 6B A3 4F   03 F8 D8 85 F4 8C 9F 8E  .R!XWk.O........\n0140: 63 B4 15 D5 A4 AE 55 48   20 66 29 91 51 66 2A C2  c.....UH f).Qf*.\n0150: 37 64 2A F5 1B FC B0 9A   99 48 95 6E EF 20 50 D5  7d*......H.n. P.\n0160: E3 E6 22 BB 6F 99 11 5A   A9 79 7E 56 EC B9 6A 54  ..\".o..Z.y.V..jT\n0170: C3 51 C2 1D 42 C1 90 1C   02 D0 21 2D AF 91 D4 31  .Q..B.....!-...1\n0180: 87 FA 62 4E 85 DF 2B 66   57 C4 B9 33 96 92 AA 44  ..bN..+fW..3...D\n0190: EC 8D 92 86 0B 7B AB DE   D0 DC 3D E2 70 68 AD 68  ..........=.ph.h\n01A0: 84 E8 AC 51 2A D0 9B E4   D8 E8 EB FE F5 FC 0E 24  ...Q*..........$\n01B0: 49 2C F1 A7 4E CE B2 A7   13 20 35 E6 C7 E5 FA D2  I,..N.... 5.....\n01C0: D4 45 7B 02 60 3E CD E9   A6 DB B1 5A 61 B7 D2 E2  .E..`>.....Za...\n01D0: 5F A5 7E 68 14 39 9A 8D   2A 05 5A 73 EF E2 74 BE  _..h.9..*.Zs..t.\n01E0: F2 7B D4 42 0D 83 32 78   43 EC 7E 9B C2 4D FD 8A  ...B..2xC....M..\n01F0: 3A 5B 2B 2F 11 DC 3D 30   EC F5 E5 7D 07 BD F2 FF  :[+/..=0........\n\n]\n-----END INTERMEDIATE CERTIFICATE #1 -----\n\n\n-----BEGIN ROOT CERTIFICATE-----\n[\n[\n  Version: V3\n  Subject: CN=Hotspot 2.0 Trust Root CA - 02, O=WFA Hotspot 2.0, C=US\n  Signature Algorithm: SHA256withRSA, OID = 1.2.840.113549.1.1.11\n\n  Key:  Sun RSA public key, 4096 bits\n  modulus: 792638386379776963560612627326855893912470807469865669361657331704603816803537228716538884420089923713620126175365944334916415693271509111815409260473015474112479914130474130953326558757576918270442304172218244844002121722427788796116970871747948797908408391696633288558131452593111081393198358147173946572123370132027080543190921617659835053232401230156771760600915712329437570568522075361583888185875498960189573344364967733768333163943604965647908899301265317317413012441934169916494206894449324835255191582952628599699785432186758739774421332129033903788784045423259533051135417824750257586596141541628803159805798706604473108998714377552419597551193846684457861657118233974990129030224473988640292887883378165213421725876945696204064405241557758891780719721890582967473442162503402773469986180422835277882936369581662492027715395290930955248360141712348640975388961574587181982962522642342639383424418515600772700394129921259402256152096929023653529141603812941608738998962930368317556485700472860732942061433763877981336550636475897090618550249579458974034651893308793874100615601196873448921563516017106953328624648152649328922743375401318967852367742959333548546346392900331073746509994796067091233049766977629494570632997201\n  public exponent: 65537\n  Validity: [From: Mon Dec 02 20:57:57 UTC 2013,\n               To: Wed Dec 02 20:55:03 UTC 2043]\n  Issuer: CN=Hotspot 2.0 Trust Root CA - 02, O=WFA Hotspot 2.0, C=US\n  SerialNumber: [    01]\n\nCertificate Extensions: 3\n[1]: ObjectId: 2.5.29.19 Criticality=true\nBasicConstraints:[\n  CA:true\n  PathLen:2147483647\n]\n\n[2]: ObjectId: 2.5.29.15 Criticality=true\nKeyUsage [\n  DigitalSignature\n  Non_repudiation\n  Key_CertSign\n  Crl_Sign\n]\n\n[3]: ObjectId: 2.5.29.14 Criticality=false\nSubjectKeyIdentifier [\nKeyIdentifier [\n0000: E4 2F 5C D4 E3 2C 07 EF   CC 3B 09 7D 38 A1 B6 0F  ./\..,...;..8...\n0010: F5 D2 C2 B5                                        ....\n]\n]\n\n]\n  Algorithm: [SHA256withRSA]\n  Signature:\n0000: 65 0B 60 4F D5 AE 70 37   2B 4A 6D 80 7A D6 95 0A  e.`O..p7+Jm.z...\n0010: 0F 7E 9E 70 1A F4 9C 82   C9 B2 D3 0A 7D A8 4D DB  ...p..........M.\n0020: EA 7F F8 6C B7 A1 04 A6   F9 C3 86 37 25 50 3D 82  ...l.......7%P=.\n0030: 3C 68 43 9C 44 DA CB 03   B5 42 D9 DE 72 A7 19 69  <hC.D....B..r..i\n0040: 8C 37 7A 8E 06 84 59 08   0E 8A 8C AB 35 F3 AD 29  .7z...Y.....5..)\n0050: D3 DB 66 D5 27 14 B1 A8   C3 27 5E 53 A7 59 C8 CD  ..f.'....'^S.Y..\n0060: F4 74 A0 FE B7 FB 66 C9   C7 E2 57 33 C7 CF 28 E2  .t....f...W3..(.\n0070: 5E DB 8E 61 8F 6A EC D5   CD C9 5E C1 82 7B E5 15  ^..a.j....^.....\n0080: AE 51 AC A2 D1 BE C1 1D   0F 76 B7 A3 69 72 7C 1D  .Q.......v..ir..\n0090: B8 41 40 77 1B 86 08 EC   0F 51 9B E8 48 26 E1 8C  [email protected]&..\n00A0: 51 28 0B 5C 55 8D EA F4   42 8A 58 01 A1 6C 2D 6A  Q(.\U...B.X..l-j\n00B0: BC 28 75 88 B3 4A A3 71   5E 1A 09 B6 AF 71 06 2F  .(u..J.q^....q./\n00C0: 87 18 24 16 F6 7E 14 8A   96 D8 C8 4A A0 83 85 8A  ..$........J....\n00D0: B8 B6 99 4E 21 E4 12 24   9C 89 0B C8 1F 5B F0 67  ...N!..$.....[.g\n00E0: 31 4D FD 95 38 CD 82 74   A3 8C 63 CB 41 71 95 F9  1M..8..t..c.Aq..\n00F0: 49 5B FC 28 0D 30 9D D1   85 12 5D 06 82 DC A4 89  I[.(.0....].....\n0100: BF 11 E2 F1 E8 92 EA FF   61 2B C7 2E C2 C6 36 92  ........a+....6.\n0110: 39 C0 F4 50 A6 B5 E3 E7   73 2D 21 D5 B1 77 ED 1D  9..P....s-!..w..\n0120: 9B 8E CB 9E 3C 5F C9 B5   F0 AA EE 49 9B 1F E6 E0  ....<_.....I....\n0130: 13 DD CE CD AA 55 ED AF   D6 20 39 55 2A 48 9C A4  .....U... 9U*H..\n0140: 34 01 D3 1A 2F C1 1C 1D   5D 0B 67 25 2A FC 4D 12  4.../...].g%*.M.\n0150: 57 CB 59 6A C6 F7 26 80   77 94 C5 5B 4F B7 C2 C6  W.Yj..&.w..[O...\n0160: 83 23 04 59 2F 9F 38 02   C1 70 C0 00 F7 28 CA 35  .#.Y/.8..p...(.5\n0170: A1 4F F6 CD 1B ED 9B 41   3E 56 08 6C B8 3F D9 20  .O.....A>V.l.?. \n0180: 4D 71 69 51 93 3D A2 FB   A6 1F D8 80 2F 7E D2 B1  MqiQ.=....../...\n0190: 87 89 E6 AE 4F C4 97 CF   A4 72 A7 78 74 46 D6 0C  ....O....r.xtF..\n01A0: 2C 56 4E 31 32 8C EF 18   E6 71 B3 19 0F 0A CE 73  ,VN12....q.....s\n01B0: E2 7F 5E 32 BD 75 B8 82   AA 5C 79 FC 1F 0F D3 15  ..^2.u...\y.....\n01C0: 9A 61 81 F3 BC 4E 7F 7D   A7 E2 3D 8C E8 1B 21 55  .a...N....=...!U\n01D0: 51 7A AE BB 47 45 08 24   2B BE 31 7F CB 4B 42 4C  Qz..GE.$+.1..KBL\n01E0: F9 B8 85 08 A6 DE 4D 45   FB 93 42 85 C6 DE 36 08  ......ME..B...6.\n01F0: 0D FA 4A BE 55 D9 52 A8   F8 50 12 E3 98 FA 43 6F  ..J.U.R..P....Co\n\n]\n-----END ROOT CERTIFICATE-----",
        "interCertData" : [ "intermediateCertifcateData1", "intermediateCertifcateData2" ],
        "rootCertData" : "rootCertificateData"
    } ]
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "totalCount" : {
            "type" : "integer"
        },
        "hasMore" : {
            "type" : "boolean"
        },
        "firstIndex" : {
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "description" : "Identifier of the trusted CA chain certificate",
                        "type" : "string"
                    },
                    "name" : {
                        "description" : "Name of the trusted CA chain certificate",
                        "type" : "string",
                        "minLength" : 2,
                        "maxLength" : 32,
                        "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
                    },
                    "description" : {
                        "description" : "Description of the trusted CA chain certificate",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64
                    },
                    "modifierUsername" : {
                        "description" : "Modifier user name of the trusted CA chain certificate",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                    },
                    "modifiedDateTime" : {
                        "description" : "Modifier  of the trusted CA chain certificate",
                        "type" : [ "string", "null" ],
                        "maxLength" : 64,
                        "pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                    },
                    "information" : {
                        "description" : "Information of the certificates",
                        "type" : "string"
                    },
                    "interCertData" : {
                        "description" : "Intermediate data of the trusted CA chain certificates",
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "string"
                        }
                    },
                    "rootCertData" : {
                        "description" : "Root data of the trusted CA chain certificates",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

Retrieve Trusted CA Chain Certificates

GET/v11_1/certstore/trustedCAChainCert/{id}

Use this API command to retrieve an installed trusted CA chain certificates.

Response  200
HideShow
Body
{
  "id": "certificateID",
  "name": "certificateName",
  "description": "certificate description",
  "interCertData": [
    "intermediateCertifcateData1",
    "intermediateCertifcateData2"
  ],
  "rootCertData": "rootCertificateData"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the trusted CA chain certificates",
      "type": "string"
    },
    "name": {
      "description": "Name of  the trusted CA chain certificates",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the trusted CA chain certificates",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "interCertData": {
      "description": "Intermediate data of the trusted CA chain certificates",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "rootCertData": {
      "description": "Root data of the trusted CA chain certificates",
      "type": "string"
    }
  }
}

Retrieve Client Certificate

GET/v11_1/certstore/clientCert/{id}

Use this API command to retrieve a client certificate.

Response  200
HideShow
Body
{
  "id": "certificateID",
  "name": "clientCertName",
  "description": "client certs description",
  "data": "clientCertData",
  "information": "clientCertInformation",
  "intermediateData": [
    "intermediateCertifcateData1",
    "intermediateCertifcateData2"
  ],
  "rootData": "rootCertificateData",
  "privateKeyData": "privateKeyData",
  "publicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAkX+GkeM0z2KV2jceygaAa0YR1+mtXYPB9wY1SOBjbjL0iIQBQqfSmUR4G5MsgwTqBZDgWLcMmfCMtNfc7ET8uLZjzdSy7qrtOUax7KuG7Iarnp3S5oVGEpQLAqVcf1SzvNsmvTkzuQNmhCmcGNZRbpyvy0tSQBTzI4Z7xDbuVYU2i/x36uvlZuDnRwiEMlAmji5HVIW6tCOIbmn9jtLNs1h4ATXwSYgyBGZ9kHTsEUOlDpdChk8LDSDoXubKCiN0uhvp8nqqAzTZjZMz5b5/S78aONxjXyBi6AjkPFDep5EJwy0p162Ym2k6vHQ02lpP9Hu/h9MauepRgws2uedYtwIDAQAB"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the client certificate",
      "type": "string"
    },
    "name": {
      "description": "Name of the client certificate",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the client certificate",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "data": {
      "description": "Data of the client certificate",
      "type": "string"
    },
    "information": {
      "description": "Information of the client certificate",
      "type": "string"
    },
    "intermediateData": {
      "description": "Intermediate data of the client certificate",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "rootData": {
      "description": "Root data of the client certificate",
      "type": "string"
    },
    "privateKeyData": {
      "description": "Private key data of the client certificate",
      "type": "string"
    },
    "publicKey": {
      "description": "Public key data of the client certificate",
      "type": "string"
    }
  }
}

Retrieve Client Certificate List

GET/v11_1/certstore/clientCert

Use this API command to retrieve list of client certificates.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "clientCert1Id",
      "name": "clientCertName1",
      "description": "client certs description"
    },
    {
      "id": "clientCert2Id",
      "name": "clientCertName2",
      "description": "client certs 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 client certificate",
            "type": "string"
          },
          "name": {
            "description": "Name of the client certificate",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the client certificate",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          }
        }
      }
    }
  }
}

Retrieve Certificate List

GET/v11_1/certstore/certificate

Use this API command to retrieve list of installed certificates.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "rootCertificate",
      "name": "rootCertificate",
      "description": "root certificate description"
    },
    {
      "id": "hs20Certificate",
      "name": "hs20Certificate",
      "description": "Hotspot20 certificate description"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the certificate",
            "type": "string"
          },
          "name": {
            "description": "Name of the certificate",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the certificate",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          }
        }
      }
    }
  }
}

Create Certificate

POST/v11_1/certstore/certificate

Use this API command to create an installed certificate.

Request
HideShow
Body
{
  "name": "hs20Certificate",
  "description": "Hotspot20 certificate description",
  "data": "certificateData",
  "intermediateData": [
    "intermediateCertifcateData1",
    "intermediateCertifcateData2"
  ],
  "rootData": "rootCertificateData",
  "privateKeyData": "privateKeyData",
  "passphrase": "passphrase"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the certificate",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the certificate",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "data": {
      "description": "The value must be in PEM format which is a Base64 encoded DER certificate.",
      "type": "string"
    },
    "intermediateData": {
      "description": "The value must be in PEM format which is a Base64 encoded DER certificate.",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "rootData": {
      "description": "The value must be in PEM format which is a Base64 encoded DER certificate.",
      "type": "string"
    },
    "privateKeyData": {
      "description": "Incompatible with certificasSigningRequest. Must choose one to enter. The value must be in PEM format which is a Base64 encoded DER certificate.",
      "type": "string"
    },
    "certificasSigningRequest": {
      "description": "Incompatible with privateKeyData. Must choose one to enter.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "passphrase": {
      "description": "Key passphrase",
      "type": "string"
    }
  },
  "required": [
    "name",
    "data"
  ]
}
Response  201
HideShow
Body
{
  "id": "clientCertUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create CSR

POST/v11_1/certstore/csr

Use this API command to create a certificates signing request.

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

Create Trusted CA Chain Certificates

POST/v11_1/certstore/trustedCAChainCert

Use this API command to create trusted CA chain certificates.

Request
HideShow
Body
{
  "name": "LDAP trusted CA chain certs Name",
  "description": "LDAPS trusted CA chain certificates description",
  "interCertData": [
    "intermediateCertifcateData1",
    "intermediateCertifcateData2"
  ],
  "rootCertData": "rootCertificateData"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the trusted CA chain certificates",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the trusted CA chain certificates",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "interCertData": {
      "description": "Intermediate data of the trusted CA chain certificates",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "rootCertData": {
      "description": "Root data of the trusted CA chain certificates",
      "type": "string"
    }
  },
  "required": [
    "name",
    "rootCertData"
  ]
}
Response  201
HideShow
Body
{
  "id": "clientCertUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create Client Certificate

POST/v11_1/certstore/clientCert

Use this API command to create a client certificate.

Request
HideShow
Body
{
  "name": "clientCertName",
  "description": "client certificate description",
  "data": "clientCertData",
  "intermediateData": [
    "intermediateCertifcateData1",
    "intermediateCertifcateData2"
  ],
  "rootData": "rootCertificateData",
  "privateKeyData": "privateKeyData"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the client certificate",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the client certificate",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "data": {
      "description": "The value must be in PEM format which is a Base64 encoded DER client certificate.",
      "type": "string"
    },
    "intermediateData": {
      "description": "The value must be in PEM format which is a Base64 encoded DER client certificate.",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "rootData": {
      "description": "The value must be in PEM format which is a Base64 encoded DER client certificate.",
      "type": "string"
    },
    "privateKeyData": {
      "description": "The value must be in PEM format which is a Base64 encoded DER client certificate.",
      "type": "string"
    }
  },
  "required": [
    "name",
    "data",
    "privateKeyData"
  ]
}
Response  201
HideShow
Body
{
  "id": "clientCertUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v11_1/certstore/setting

Use this API command to Modify the Certificate Setting.

Request
HideShow
Body
{
  "serviceCertificates": [
    {
      "service": "MANAGEMENT_WEB",
      "certificate": {
        "id": "dc9696f0-e43e-11e5-a304-525400fbb1bb",
        "name": "newcert"
      }
    },
    {
      "service": "AP_PORTAL",
      "certificate": {
        "id": "dc9696f0-e43e-11e5-a304-525400fbb1bb",
        "name": "newcert"
      }
    },
    {
      "service": "HOTSPOT",
      "certificate": {
        "id": "11111111-1111-1111-1111-111111111111",
        "name": "Default Certificate"
      }
    },
    {
      "service": "COMMUNICATOR",
      "certificate": {
        "id": "11111111-1111-1111-1111-111111111111",
        "name": "Default Certificate"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "serviceCertificates": {
      "description": "Certificate Setting of the service",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "service": {
            "description": "the service",
            "type": "string",
            "enum": [
              "MANAGEMENT_WEB",
              "AP_PORTAL",
              "HOTSPOT",
              "COMMUNICATOR"
            ]
          },
          "certificate": {
            "description": "certificate of the service",
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "service"
        ]
      }
    }
  }
}
Response  204

Modify serviceCertificates

PATCH/v11_1/certstore/setting/serviceCertificates

Use this API command to Modify serviceCertificates of the Certificate Setting.

Request
HideShow
Body
[
  {
    "service": "MANAGEMENT_WEB",
    "certificate": {
      "id": "dc9696f0-e43e-11e5-a304-525400fbb1bb",
      "name": "newcert"
    }
  },
  {
    "service": "AP_PORTAL",
    "certificate": {
      "id": "dc9696f0-e43e-11e5-a304-525400fbb1bb",
      "name": "newcert"
    }
  },
  {
    "service": "HOTSPOT",
    "certificate": {
      "id": "11111111-1111-1111-1111-111111111111",
      "name": "Default Certificate"
    }
  },
  {
    "service": "COMMUNICATOR",
    "certificate": {
      "id": "11111111-1111-1111-1111-111111111111",
      "name": "Default Certificate"
    }
  }
]
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "service": {
        "description": "the service",
        "type": "string",
        "enum": [
          "MANAGEMENT_WEB",
          "AP_PORTAL",
          "HOTSPOT",
          "COMMUNICATOR"
        ]
      },
      "certificate": {
        "description": "certificate of the service",
        "type": [
          "object",
          "null"
        ],
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    },
    "required": [
      "service"
    ]
  }
}
Response  204

Patch Trusted CA Chain Certificates

PATCH/v11_1/certstore/trustedCAChainCert/{id}

Use this API command to patch a trusted CA chain certificates.

Request
HideShow
Body
{
    "name" : "LDAP trusted CA chain certs Name",
    "description" : "LDAPS trusted CA chain certificates description",
    "information" : "\n\n-----BEGIN INTERMEDIATE CERTIFICATE #1 -----\n[\n[\n  Version: V3\n  Subject: CN=Verizon Hotspot 2.0 Intermediate CA, OU=Cybertrust, O=Verizon Enterprise Solutions, L=Amsterdam, C=NL\n  Signature Algorithm: SHA256withRSA, OID = 1.2.840.113549.1.1.11\n\n  Key:  Sun RSA public key, 2048 bits\n  modulus: 23617561117988111216066421024092057505707971583866555863467960236740199253262690005512455723125315310387461393165651970748842793301611918034442594711994634192423187372806761353350113250438225110389282744014438367665821734885051972120241834680068338044857354569175288575440030311710708015575344394358723355054477230016829047631782713506713276018655043123697918236044268053319322704458844413722254348232276124596584542075041243826757391193963245254337908100807532825175242207243382889107249881414575066011404307393987338973084479538528154253484161987803827349486330380817232385299053004582804890215693233201596774334823\n  public exponent: 65537\n  Validity: [From: Mon Aug 11 18:44:39 UTC 2014,\n               To: Sun Aug 11 18:44:09 UTC 2024]\n  Issuer: CN=Hotspot 2.0 Trust Root CA - 02, O=WFA Hotspot 2.0, C=US\n  SerialNumber: [    cb]\n\nCertificate Extensions: 6\n[1]: ObjectId: 1.3.6.1.5.5.7.1.1 Criticality=false\nAuthorityInfoAccess [\n  [\n   accessMethod: ocsp\n   accessLocation: URIName: http://ocsp.omniroot.com/hotspotroot\n]\n]\n\n[2]: ObjectId: 2.5.29.35 Criticality=false\nAuthorityKeyIdentifier [\nKeyIdentifier [\n0000: E4 2F 5C D4 E3 2C 07 EF   CC 3B 09 7D 38 A1 B6 0F  ./\..,...;..8...\n0010: F5 D2 C2 B5                                        ....\n]\n]\n\n[3]: ObjectId: 2.5.29.19 Criticality=true\nBasicConstraints:[\n  CA:true\n  PathLen:0\n]\n\n[4]: ObjectId: 2.5.29.32 Criticality=false\nCertificatePolicies [\n  [CertificatePolicyId: [1.3.6.1.4.1.6334.1.600.1]\n[PolicyQualifierInfo: [\n  qualifierID: 1.3.6.1.5.5.7.2.1\n  qualifier: 0000: 16 27 20 68 74 74 70 73   3A 2F 2F 73 65 63 75 72  .' https://secur\n0010: 65 2E 6F 6D 6E 69 72 6F   6F 74 2E 63 6F 6D 2F 72  e.omniroot.com/r\n0020: 65 70 6F 73 69 74 6F 72   79                       epository\n\n]]  ]\n]\n\n[5]: ObjectId: 2.5.29.15 Criticality=true\nKeyUsage [\n  DigitalSignature\n  Non_repudiation\n  Key_CertSign\n  Crl_Sign\n]\n\n[6]: ObjectId: 2.5.29.14 Criticality=false\nSubjectKeyIdentifier [\nKeyIdentifier [\n0000: 5C 5D 9D B6 A0 47 88 1B   61 40 E1 B7 E6 42 CE 81  \][email protected]..\n0010: 2F 44 6E 40                                        /Dn@\n]\n]\n\n]\n  Algorithm: [SHA256withRSA]\n  Signature:\n0000: 86 44 36 50 5A F2 92 22   B1 CD F1 3F 76 46 D0 F2  .D6PZ..\"...?vF..\n0010: 21 71 E8 7C CD 15 67 69   F0 0A AE 07 34 61 B4 2F  !q....gi....4a./\n0020: 9A 7F E1 70 5C 87 BA F5   62 6C D9 C9 C9 4D 38 15  ...p\...bl...M8.\n0030: C2 9A 3F 1A 9E 94 A3 2E   EB 77 76 D7 46 75 0F EC  ..?......wv.Fu..\n0040: C5 CF 38 EB 52 4E FC 3D   65 05 45 40 8B 17 12 87  ..8.RN.=e.E@....\n0050: FE E3 CB 47 46 2F DC 22   00 9D C6 20 05 53 11 0A  ...GF/.\"... .S..\n0060: 4B 1B 01 4C 39 2F DA 4B   4F FF 65 06 39 36 05 82  K..L9/.KO.e.96..\n0070: 81 6F 9E E5 FB 9B AF 81   91 75 63 AF EC BA 7E D8  .o.......uc.....\n0080: 99 D2 B1 FA E6 34 68 DD   03 6F 9A FE FA F8 E7 12  .....4h..o......\n0090: D0 7E A8 34 2B 2F E2 A6   9D A9 84 38 4D 8F 58 14  ...4+/.....8M.X.\n00A0: FD A3 02 04 E9 81 74 BD   E6 14 F7 69 32 E9 CF 17  ......t....i2...\n00B0: 7A 45 C7 0F F8 22 A8 7E   A5 8A 26 8F 3B 06 45 86  zE...\"....&.;.E.\n00C0: 09 E8 D6 AB 35 E8 C1 E2   EC F2 A0 B6 8F 39 70 D8  ....5........9p.\n00D0: AF 71 80 2C E7 45 DE 6A   78 5A 98 B7 72 CD 73 B8  .q.,.E.jxZ..r.s.\n00E0: 33 4F 56 C7 95 58 13 B4   23 8D CC F1 BC 72 2A ED  3OV..X..#....r*.\n00F0: 70 20 CD 5F DD 47 99 BD   E0 46 8E E2 37 86 0B F9  p ._.G...F..7...\n0100: 47 A4 5A EC F5 A4 93 C7   F4 C3 44 86 FA 00 C5 D1  G.Z.......D.....\n0110: FA C3 D8 72 1E 1E 66 3B   9E 44 51 0C 5B 41 29 AF  ...r..f;.DQ.[A).\n0120: A1 73 9B 4E 27 BF 91 22   97 C6 B1 EC E8 48 A5 F5  .s.N'..\".....H..\n0130: EF 52 21 58 57 6B A3 4F   03 F8 D8 85 F4 8C 9F 8E  .R!XWk.O........\n0140: 63 B4 15 D5 A4 AE 55 48   20 66 29 91 51 66 2A C2  c.....UH f).Qf*.\n0150: 37 64 2A F5 1B FC B0 9A   99 48 95 6E EF 20 50 D5  7d*......H.n. P.\n0160: E3 E6 22 BB 6F 99 11 5A   A9 79 7E 56 EC B9 6A 54  ..\".o..Z.y.V..jT\n0170: C3 51 C2 1D 42 C1 90 1C   02 D0 21 2D AF 91 D4 31  .Q..B.....!-...1\n0180: 87 FA 62 4E 85 DF 2B 66   57 C4 B9 33 96 92 AA 44  ..bN..+fW..3...D\n0190: EC 8D 92 86 0B 7B AB DE   D0 DC 3D E2 70 68 AD 68  ..........=.ph.h\n01A0: 84 E8 AC 51 2A D0 9B E4   D8 E8 EB FE F5 FC 0E 24  ...Q*..........$\n01B0: 49 2C F1 A7 4E CE B2 A7   13 20 35 E6 C7 E5 FA D2  I,..N.... 5.....\n01C0: D4 45 7B 02 60 3E CD E9   A6 DB B1 5A 61 B7 D2 E2  .E..`>.....Za...\n01D0: 5F A5 7E 68 14 39 9A 8D   2A 05 5A 73 EF E2 74 BE  _..h.9..*.Zs..t.\n01E0: F2 7B D4 42 0D 83 32 78   43 EC 7E 9B C2 4D FD 8A  ...B..2xC....M..\n01F0: 3A 5B 2B 2F 11 DC 3D 30   EC F5 E5 7D 07 BD F2 FF  :[+/..=0........\n\n]\n-----END INTERMEDIATE CERTIFICATE #1 -----\n\n\n-----BEGIN ROOT CERTIFICATE-----\n[\n[\n  Version: V3\n  Subject: CN=Hotspot 2.0 Trust Root CA - 02, O=WFA Hotspot 2.0, C=US\n  Signature Algorithm: SHA256withRSA, OID = 1.2.840.113549.1.1.11\n\n  Key:  Sun RSA public key, 4096 bits\n  modulus: 792638386379776963560612627326855893912470807469865669361657331704603816803537228716538884420089923713620126175365944334916415693271509111815409260473015474112479914130474130953326558757576918270442304172218244844002121722427788796116970871747948797908408391696633288558131452593111081393198358147173946572123370132027080543190921617659835053232401230156771760600915712329437570568522075361583888185875498960189573344364967733768333163943604965647908899301265317317413012441934169916494206894449324835255191582952628599699785432186758739774421332129033903788784045423259533051135417824750257586596141541628803159805798706604473108998714377552419597551193846684457861657118233974990129030224473988640292887883378165213421725876945696204064405241557758891780719721890582967473442162503402773469986180422835277882936369581662492027715395290930955248360141712348640975388961574587181982962522642342639383424418515600772700394129921259402256152096929023653529141603812941608738998962930368317556485700472860732942061433763877981336550636475897090618550249579458974034651893308793874100615601196873448921563516017106953328624648152649328922743375401318967852367742959333548546346392900331073746509994796067091233049766977629494570632997201\n  public exponent: 65537\n  Validity: [From: Mon Dec 02 20:57:57 UTC 2013,\n               To: Wed Dec 02 20:55:03 UTC 2043]\n  Issuer: CN=Hotspot 2.0 Trust Root CA - 02, O=WFA Hotspot 2.0, C=US\n  SerialNumber: [    01]\n\nCertificate Extensions: 3\n[1]: ObjectId: 2.5.29.19 Criticality=true\nBasicConstraints:[\n  CA:true\n  PathLen:2147483647\n]\n\n[2]: ObjectId: 2.5.29.15 Criticality=true\nKeyUsage [\n  DigitalSignature\n  Non_repudiation\n  Key_CertSign\n  Crl_Sign\n]\n\n[3]: ObjectId: 2.5.29.14 Criticality=false\nSubjectKeyIdentifier [\nKeyIdentifier [\n0000: E4 2F 5C D4 E3 2C 07 EF   CC 3B 09 7D 38 A1 B6 0F  ./\..,...;..8...\n0010: F5 D2 C2 B5                                        ....\n]\n]\n\n]\n  Algorithm: [SHA256withRSA]\n  Signature:\n0000: 65 0B 60 4F D5 AE 70 37   2B 4A 6D 80 7A D6 95 0A  e.`O..p7+Jm.z...\n0010: 0F 7E 9E 70 1A F4 9C 82   C9 B2 D3 0A 7D A8 4D DB  ...p..........M.\n0020: EA 7F F8 6C B7 A1 04 A6   F9 C3 86 37 25 50 3D 82  ...l.......7%P=.\n0030: 3C 68 43 9C 44 DA CB 03   B5 42 D9 DE 72 A7 19 69  <hC.D....B..r..i\n0040: 8C 37 7A 8E 06 84 59 08   0E 8A 8C AB 35 F3 AD 29  .7z...Y.....5..)\n0050: D3 DB 66 D5 27 14 B1 A8   C3 27 5E 53 A7 59 C8 CD  ..f.'....'^S.Y..\n0060: F4 74 A0 FE B7 FB 66 C9   C7 E2 57 33 C7 CF 28 E2  .t....f...W3..(.\n0070: 5E DB 8E 61 8F 6A EC D5   CD C9 5E C1 82 7B E5 15  ^..a.j....^.....\n0080: AE 51 AC A2 D1 BE C1 1D   0F 76 B7 A3 69 72 7C 1D  .Q.......v..ir..\n0090: B8 41 40 77 1B 86 08 EC   0F 51 9B E8 48 26 E1 8C  [email protected]&..\n00A0: 51 28 0B 5C 55 8D EA F4   42 8A 58 01 A1 6C 2D 6A  Q(.\U...B.X..l-j\n00B0: BC 28 75 88 B3 4A A3 71   5E 1A 09 B6 AF 71 06 2F  .(u..J.q^....q./\n00C0: 87 18 24 16 F6 7E 14 8A   96 D8 C8 4A A0 83 85 8A  ..$........J....\n00D0: B8 B6 99 4E 21 E4 12 24   9C 89 0B C8 1F 5B F0 67  ...N!..$.....[.g\n00E0: 31 4D FD 95 38 CD 82 74   A3 8C 63 CB 41 71 95 F9  1M..8..t..c.Aq..\n00F0: 49 5B FC 28 0D 30 9D D1   85 12 5D 06 82 DC A4 89  I[.(.0....].....\n0100: BF 11 E2 F1 E8 92 EA FF   61 2B C7 2E C2 C6 36 92  ........a+....6.\n0110: 39 C0 F4 50 A6 B5 E3 E7   73 2D 21 D5 B1 77 ED 1D  9..P....s-!..w..\n0120: 9B 8E CB 9E 3C 5F C9 B5   F0 AA EE 49 9B 1F E6 E0  ....<_.....I....\n0130: 13 DD CE CD AA 55 ED AF   D6 20 39 55 2A 48 9C A4  .....U... 9U*H..\n0140: 34 01 D3 1A 2F C1 1C 1D   5D 0B 67 25 2A FC 4D 12  4.../...].g%*.M.\n0150: 57 CB 59 6A C6 F7 26 80   77 94 C5 5B 4F B7 C2 C6  W.Yj..&.w..[O...\n0160: 83 23 04 59 2F 9F 38 02   C1 70 C0 00 F7 28 CA 35  .#.Y/.8..p...(.5\n0170: A1 4F F6 CD 1B ED 9B 41   3E 56 08 6C B8 3F D9 20  .O.....A>V.l.?. \n0180: 4D 71 69 51 93 3D A2 FB   A6 1F D8 80 2F 7E D2 B1  MqiQ.=....../...\n0190: 87 89 E6 AE 4F C4 97 CF   A4 72 A7 78 74 46 D6 0C  ....O....r.xtF..\n01A0: 2C 56 4E 31 32 8C EF 18   E6 71 B3 19 0F 0A CE 73  ,VN12....q.....s\n01B0: E2 7F 5E 32 BD 75 B8 82   AA 5C 79 FC 1F 0F D3 15  ..^2.u...\y.....\n01C0: 9A 61 81 F3 BC 4E 7F 7D   A7 E2 3D 8C E8 1B 21 55  .a...N....=...!U\n01D0: 51 7A AE BB 47 45 08 24   2B BE 31 7F CB 4B 42 4C  Qz..GE.$+.1..KBL\n01E0: F9 B8 85 08 A6 DE 4D 45   FB 93 42 85 C6 DE 36 08  ......ME..B...6.\n01F0: 0D FA 4A BE 55 D9 52 A8   F8 50 12 E3 98 FA 43 6F  ..J.U.R..P....Co\n\n]\n-----END ROOT CERTIFICATE-----",
    "interCertData" : [ "intermediateCertifcateData1", "intermediateCertifcateData2" ],
    "rootCertData" : "rootCertificateData"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the trusted CA chain certificates",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the trusted CA chain certificates",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "information" : {
            "description" : "Information of the certificates",
            "type" : "string"
        },
        "interCertData" : {
            "description" : "Intermediate data of the trusted CA chain certificates",
            "type" : [ "array", "null" ],
            "items" : {
                "type" : "string"
            }
        },
        "rootCertData" : {
            "description" : "Root data of the trusted CA chain certificates",
            "type" : "string"
        }
    }
}
Response  204

Delete Certificate

DELETE/v11_1/certstore/certificate/{id}

Use this API command to delete an installed certificate.

Response  204

Delete CSR

DELETE/v11_1/certstore/csr/{id}

Use this API command to delete a certificates signing request.

Response  204

Delete Trusted CA Chain Certificates

DELETE/v11_1/certstore/trustedCAChainCert/{id}

Use this API command to delete a trusted CA chain certificate.

Response  204

Delete bulk Trusted CA Chain Certificates

DELETE/v11_1/certstore/trustedCAChainCert

Use this API command to delete bulk trusted CA chain certificates.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Delete Client Certificate

DELETE/v11_1/certstore/clientCert/{id}

Use this API command to delete a client certificate.

Response  204

Application Visibility Control

Application Policy Retrieve

GET/v11_1/avc/applicationPolicy/{id}

Use this API command to retrieve a AVC Application Policy profile (for 5.0 and Earlier Firmware Versions).

Response  200
HideShow
Body
{
  "name": "postman-dp-c",
  "id": "ba7b3fb0-f2fb-11e4-b680-80fa5b024259",
  "description": "postman-dp-c",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "applicationRules": [
    {
      "ruleType": "DENY",
      "applicationType": "SIGNATURE",
      "catId": "126",
      "appId": "1"
    }
  ],
  "avcLogEnable": false,
  "avcEventEnable": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the Application Policy Profile",
      "type": "string"
    },
    "tenantId": {
      "description": "Tenant Id",
      "type": "string"
    },
    "domainId": {
      "description": "Identifier of the System (root) domain or partner managed domain to which the Application Policy Profile belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the Application Policy Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Application Policy Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "applicationRules": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "type": "integer"
          },
          "ruleType": {
            "description": "Type of the application rule",
            "type": "string",
            "enum": [
              "DENY",
              "QOS",
              "RATE_LIMITING"
            ]
          },
          "applicationType": {
            "description": "Type of the application when ruleType",
            "type": "string",
            "enum": [
              "SIGNATURE",
              "USER_DEFINED"
            ]
          },
          "catId": {
            "description": "Identifier of the Application Category from Signature Package (If applicationType is UserDefind, the catId is 32768)",
            "type": "string"
          },
          "catName": {
            "description": "Name of the Application Category from Signature Package",
            "type": "string"
          },
          "appId": {
            "description": "Identifier of the Application from Signature Package",
            "type": "string"
          },
          "appName": {
            "description": "Name of the Application from Signature Package",
            "type": "string"
          },
          "uplink": {
            "description": "Uplink rate limiting (unit: Kbps)",
            "type": "integer"
          },
          "downlink": {
            "description": "Downlink rate limiting (unit: Kbps)",
            "type": "integer"
          },
          "markingPriority": {
            "description": "QoS uplink marking priority",
            "type": "string",
            "enum": [
              "IEEE802_1p",
              "DSCP",
              "BOTH"
            ]
          },
          "markingType": {
            "description": "QoS uplink marking type",
            "type": "string",
            "enum": [
              "VOICE",
              "VIDEO",
              "BEST_EFFORT",
              "BACKGROUND"
            ]
          },
          "classificationType": {
            "description": "QoS downlink classification type",
            "type": "string",
            "enum": [
              "VOICE",
              "VIDEO",
              "BEST_EFFORT",
              "BACKGROUND"
            ]
          }
        }
      }
    },
    "avcLogEnable": {
      "description": "Send ARC logs from AP to external syslog server",
      "type": "boolean"
    },
    "avcEventEnable": {
      "description": "Send ARC logs from AP to SmartZone",
      "type": "boolean"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Application Policy V2 Retrieve

GET/v11_1/avc/applicationPolicyV2/{id}

Use this API command to retrieve a AVC Application Policy profile.

Response  200
HideShow
Body
{
  "name": "postman-dp-c",
  "id": "ba7b3fb0-f2fb-11e4-b680-80fa5b024259",
  "description": "postman-dp-c",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "applicationRules": [
    {
      "ruleType": "DENY",
      "applicationType": "SIGNATURE",
      "catId": "126",
      "appId": "1"
    }
  ],
  "avcLogEnable": false,
  "avcEventEnable": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the Application Policy Profile",
      "type": "string"
    },
    "tenantId": {
      "description": "Tenant Id",
      "type": "string"
    },
    "domainId": {
      "description": "Identifier of the System (root) domain or partner managed domain to which the Application Policy Profile belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the Application Policy Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Application Policy Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "applicationRules": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "type": "integer"
          },
          "ruleType": {
            "description": "Type of the application rule",
            "type": "string",
            "enum": [
              "DENY",
              "QOS",
              "RATE_LIMITING"
            ]
          },
          "applicationType": {
            "description": "Type of the application when ruleType",
            "type": "string",
            "enum": [
              "SIGNATURE",
              "USER_DEFINED"
            ]
          },
          "catId": {
            "description": "Identifier of the Application Category from Signature Package (If applicationType is UserDefind, the catId is 32768)",
            "type": "string"
          },
          "catName": {
            "description": "Name of the Application Category from Signature Package",
            "type": "string"
          },
          "appId": {
            "description": "Identifier of the Application from Signature Package",
            "type": "string"
          },
          "appName": {
            "description": "Name of the Application from Signature Package",
            "type": "string"
          },
          "uplink": {
            "description": "Uplink rate limiting (unit: Kbps)",
            "type": "integer"
          },
          "downlink": {
            "description": "Downlink rate limiting (unit: Kbps)",
            "type": "integer"
          },
          "markingPriority": {
            "description": "QoS uplink marking priority",
            "type": "string",
            "enum": [
              "IEEE802_1p",
              "DSCP",
              "BOTH"
            ]
          },
          "markingType": {
            "description": "QoS uplink marking type",
            "type": "string",
            "enum": [
              "VOICE",
              "VIDEO",
              "BEST_EFFORT",
              "BACKGROUND"
            ]
          },
          "classificationType": {
            "description": "QoS downlink classification type",
            "type": "string",
            "enum": [
              "VOICE",
              "VIDEO",
              "BEST_EFFORT",
              "BACKGROUND"
            ]
          }
        }
      }
    },
    "avcLogEnable": {
      "description": "Send ARC logs from AP to external syslog server",
      "type": "boolean"
    },
    "avcEventEnable": {
      "description": "Send ARC logs from AP to SmartZone",
      "type": "boolean"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Current Signature Package Info

GET/v11_1/avc/signaturePackage

Get current Signature Package info (for 5.0 and Earlier Firmware Versions).

Response  200
HideShow
Body
{
  "id": "acc29c30-ee35-11e4-8c03-000c292547b9",
  "fileName": "RuckusSigPack-1.005",
  "size": "629145",
  "version": "1.5",
  "binariesInfo": [
    {
      "fileName": "ppc-lib.tar.gz",
      "size": 3343608,
      "type": "CLASSIFICATION",
      "platform": "PPC"
    },
    {
      "fileName": "arm-lib.tar.gz",
      "size": 3391401,
      "type": "CLASSIFICATION",
      "platform": "ARM"
    },
    {
      "fileName": "mips-lib.tar.gz",
      "size": 3539066,
      "type": "CLASSIFICATION",
      "platform": "MIPS"
    },
    {
      "fileName": "arm-regular-lib.tar.gz",
      "size": 4945412,
      "type": "REGULAR",
      "platform": "ARM"
    }
  ],
  "checkLatestInstallableSettings": {
    "checkEnabled": true,
    "dateOfMonth": 1
  },
  "latestInstallable": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the Signature Package",
      "type": "string"
    },
    "fileName": {
      "description": "Name of the Signature Package",
      "type": "string"
    },
    "version": {
      "description": "Version of the Signature Package",
      "type": "string"
    },
    "size": {
      "description": "Size of the Signature Package",
      "type": "integer",
      "format": "int64"
    },
    "binariesInfo": {
      "description": "General information about the binary files in the Signature Package",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "fileName": {
            "description": "File name of the Signature Package Binary",
            "type": "string"
          },
          "platform": {
            "description": "AP platform the Signature Package Binary supports",
            "type": "string",
            "enum": [
              "CLASSIFICATION",
              "REGULAR"
            ]
          },
          "type": {
            "description": "Type of the Signature Package Binary",
            "type": "string",
            "enum": [
              "ARM",
              "PPC",
              "MIPS"
            ]
          },
          "size": {
            "description": "The size of signature package binary file",
            "type": "integer"
          }
        }
      }
    },
    "checkLatestInstallableSettings": {
      "description": "Configurable settings for checking if there exists latest installable Signature Package for download in the support site",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "checkEnabled": {
          "description": "Enable or disable the periodic check for latest installable signature package",
          "type": "boolean"
        },
        "dateOfMonth": {
          "description": "date of the month",
          "type": "integer",
          "minimum": 1,
          "maximum": 31
        }
      }
    },
    "latestInstallable": {
      "description": "The latest installable Signature Package that fits this SZ for download in the support site",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "description": "The version of the latest installable signature package",
          "type": "string"
        },
        "binariesInfo": {
          "description": "The binaries information of the latest installable signature package",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "fileName": {
                "description": "File name of the latest installable Signature Package Binary",
                "type": "string"
              },
              "platform": {
                "description": "AP platform the latest installable Signature Package Binary supports",
                "type": "string",
                "enum": [
                  "CLASSIFICATION",
                  "REGULAR"
                ]
              },
              "type": {
                "description": "Type of the latest installable Signature Package Binary",
                "type": "string",
                "enum": [
                  "ARM",
                  "PPC",
                  "MIPS"
                ]
              }
            }
          }
        },
        "lastCheckedTime": {
          "description": "The last checked time for the latest installable signature package",
          "type": "integer"
        }
      }
    }
  }
}

Application Categories

GET/v11_1/avc/signaturePackage/categories

Get Application Category list from current Signature Package (for 5.0 and Earlier Firmware Versions).

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "128",
      "name": "Instant messaging"
    },
    {
      "id": "129",
      "name": "P2P"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the Application Category",
            "type": "string"
          },
          "name": {
            "description": "Name of the Application Category",
            "type": "string"
          }
        }
      }
    }
  }
}

Applications

GET/v11_1/avc/signaturePackage/applications

Get Application list from current Signature Package (for 5.0 and Earlier Firmware Versions).

Response  200
HideShow
Body
{
  "totalCount": 5,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "catId": "128",
      "appId": "1",
      "name": "MSN"
    },
    {
      "catId": "128",
      "appId": "2",
      "name": "Yahoo Messenger"
    },
    {
      "catId": "128",
      "appId": "3",
      "name": "AIM/ICQ/iIM"
    },
    {
      "catId": "129",
      "appId": "2",
      "name": "BitTorrent Series"
    },
    {
      "catId": "129",
      "appId": "4",
      "name": "DirectConnect"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "catId": {
            "description": "Identifier of the Application Category",
            "type": "string"
          },
          "appId": {
            "description": "Identifier of the Application",
            "type": "string"
          },
          "name": {
            "description": "Name of the Application",
            "type": "string"
          }
        }
      }
    }
  }
}

Application Category

GET/v11_1/avc/signaturePackage/category/{categoryName}

Get Application Category info (catId and name) by category name (for 5.0 and Earlier Firmware Versions).

Response  200
HideShow
Body
{
  "id": "128",
  "name": "Instant messaging"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the Application Category",
      "type": "string"
    },
    "name": {
      "description": "Name of the Application Category",
      "type": "string"
    }
  }
}

Application

GET/v11_1/avc/signaturePackage/application/{applicationName}

Get Application info (catId, appId and name) by application name (for 5.0 and Earlier Firmware Versions).

Response  200
HideShow
Body
{
  "catId": "128",
  "appId": "1",
  "name": "MSN"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "catId": {
      "description": "Identifier of the Application Category",
      "type": "string"
    },
    "appId": {
      "description": "Identifier of the Application",
      "type": "string"
    },
    "name": {
      "description": "Name of the Application",
      "type": "string"
    }
  }
}

User Defined Retrieve

GET/v11_1/avc/userDefined/{id}

Use this API command to retrieve a AVC User Defined profile.

Response  200
HideShow
Body
{
  "name": "test-modify",
  "type": "IP_WITH_PORT",
  "id": "acc29c30-ee35-11e4-8c03-000c292547b9",
  "appId": 1,
  "destIp": "11.22.33.44",
  "netmask": "255.255.255.0",
  "destPort": 22,
  "protocol": "TCP"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the User Defined Application",
      "type": "string"
    },
    "appId": {
      "description": "AppId for Application Policy's User defined rule type",
      "type": "integer"
    },
    "tenantId": {
      "description": "Tenant Id",
      "type": "string"
    },
    "domainId": {
      "description": "Identifier of the System (root) domain or partner managed domain to which the User Defined Application belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the User Defined Application Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "type": {
      "description": "Type of the User Defined Application",
      "type": "string",
      "enum": [
        "IP_WITH_PORT",
        "PORT_ONLY"
      ]
    },
    "destIp": {
      "description": "Destination Server IP",
      "type": "string"
    },
    "netmask": {
      "description": "Netmask of User Defined Application",
      "type": "string",
      "pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
    },
    "destPort": {
      "description": "Destination Port of User Defined Application",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "protocol": {
      "description": "Protocol of User Defined Application",
      "type": "string",
      "enum": [
        "TCP",
        "UDP"
      ]
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Current Signature Package Info

GET/v11_1/avc/signaturePackageV2

Get current Signature Package info.

Response  200
HideShow
Body
{
  "id": "acc29c30-ee35-11e4-8c03-000c292547b9",
  "fileName": "RuckusSigPack-1.005",
  "size": "629145",
  "version": "1.5",
  "binariesInfo": [
    {
      "fileName": "ppc-lib.tar.gz",
      "size": 3343608,
      "type": "CLASSIFICATION",
      "platform": "PPC"
    },
    {
      "fileName": "arm-lib.tar.gz",
      "size": 3391401,
      "type": "CLASSIFICATION",
      "platform": "ARM"
    },
    {
      "fileName": "mips-lib.tar.gz",
      "size": 3539066,
      "type": "CLASSIFICATION",
      "platform": "MIPS"
    },
    {
      "fileName": "arm-regular-lib.tar.gz",
      "size": 4945412,
      "type": "REGULAR",
      "platform": "ARM"
    }
  ],
  "checkLatestInstallableSettings": {
    "checkEnabled": true,
    "dateOfMonth": 1
  },
  "latestInstallable": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the Signature Package",
      "type": "string"
    },
    "fileName": {
      "description": "Name of the Signature Package",
      "type": "string"
    },
    "version": {
      "description": "Version of the Signature Package",
      "type": "string"
    },
    "size": {
      "description": "Size of the Signature Package",
      "type": "integer",
      "format": "int64"
    },
    "binariesInfo": {
      "description": "General information about the binary files in the Signature Package",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "fileName": {
            "description": "File name of the Signature Package Binary",
            "type": "string"
          },
          "platform": {
            "description": "AP platform the Signature Package Binary supports",
            "type": "string",
            "enum": [
              "CLASSIFICATION",
              "REGULAR"
            ]
          },
          "type": {
            "description": "Type of the Signature Package Binary",
            "type": "string",
            "enum": [
              "ARM",
              "PPC",
              "MIPS"
            ]
          },
          "size": {
            "description": "The size of signature package binary file",
            "type": "integer"
          }
        }
      }
    },
    "checkLatestInstallableSettings": {
      "description": "Configurable settings for checking if there exists latest installable Signature Package for download in the support site",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "checkEnabled": {
          "description": "Enable or disable the periodic check for latest installable signature package",
          "type": "boolean"
        },
        "dateOfMonth": {
          "description": "date of the month",
          "type": "integer",
          "minimum": 1,
          "maximum": 31
        }
      }
    },
    "latestInstallable": {
      "description": "The latest installable Signature Package that fits this SZ for download in the support site",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "description": "The version of the latest installable signature package",
          "type": "string"
        },
        "binariesInfo": {
          "description": "The binaries information of the latest installable signature package",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "fileName": {
                "description": "File name of the latest installable Signature Package Binary",
                "type": "string"
              },
              "platform": {
                "description": "AP platform the latest installable Signature Package Binary supports",
                "type": "string",
                "enum": [
                  "CLASSIFICATION",
                  "REGULAR"
                ]
              },
              "type": {
                "description": "Type of the latest installable Signature Package Binary",
                "type": "string",
                "enum": [
                  "ARM",
                  "PPC",
                  "MIPS"
                ]
              }
            }
          }
        },
        "lastCheckedTime": {
          "description": "The last checked time for the latest installable signature package",
          "type": "integer"
        }
      }
    }
  }
}

Application Categories

GET/v11_1/avc/signaturePackageV2/categories

Get Application Category list from current Signature Package.

URI Parameters
HideShow
catName
string (optional) 

Category name. Get Application Category info (catId and name) by the category name.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "128",
      "name": "Instant messaging"
    },
    {
      "id": "129",
      "name": "P2P"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the Application Category",
            "type": "string"
          },
          "name": {
            "description": "Name of the Application Category",
            "type": "string"
          }
        }
      }
    }
  }
}

Applications

GET/v11_1/avc/signaturePackageV2/applications

Get Application list from current Signature Package.

URI Parameters
HideShow
appName
string (optional) 

Application name. Get Application info (catId, appId and name) by the application name.

Response  200
HideShow
Body
{
  "totalCount": 5,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "catId": "128",
      "appId": "1",
      "name": "MSN"
    },
    {
      "catId": "128",
      "appId": "2",
      "name": "Yahoo Messenger"
    },
    {
      "catId": "128",
      "appId": "3",
      "name": "AIM/ICQ/iIM"
    },
    {
      "catId": "129",
      "appId": "2",
      "name": "BitTorrent Series"
    },
    {
      "catId": "129",
      "appId": "4",
      "name": "DirectConnect"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "catId": {
            "description": "Identifier of the Application Category",
            "type": "string"
          },
          "appId": {
            "description": "Identifier of the Application",
            "type": "string"
          },
          "name": {
            "description": "Name of the Application",
            "type": "string"
          }
        }
      }
    }
  }
}

Download and Install Progress

GET/v11_1/avc/signaturePackageV2/downloadAndInstallLastChecked/progress

Get the progress of download and install Signature Package.

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "message": {
      "description": "The message of current download process",
      "type": "string"
    },
    "state": {
      "description": "The state of current download process",
      "type": "string"
    },
    "latestInstallable": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "description": "The version of the latest installable signature package",
          "type": "string"
        },
        "binariesInfo": {
          "description": "The binaries information of the latest installable signature package",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "fileName": {
                "description": "File name of the latest installable Signature Package Binary",
                "type": "string"
              },
              "platform": {
                "description": "AP platform the latest installable Signature Package Binary supports",
                "type": "string",
                "enum": [
                  "CLASSIFICATION",
                  "REGULAR"
                ]
              },
              "type": {
                "description": "Type of the latest installable Signature Package Binary",
                "type": "string",
                "enum": [
                  "ARM",
                  "PPC",
                  "MIPS"
                ]
              }
            }
          }
        },
        "lastCheckedTime": {
          "description": "The last checked time for the latest installable signature package",
          "type": "integer"
        }
      }
    }
  }
}

Application Policy Create

POST/v11_1/avc/applicationPolicy

Use this API command to create a new AVC Application Policy profile (for 5.0 and Earlier Firmware Versions).

Request
HideShow
Body
{
  "name": "aa",
  "description": "",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "applicationRules": [
    {
      "ruleType": "DENY",
      "applicationType": "USER_DEFINED",
      "catId": "32768",
      "appId": "2",
      "priority": 1
    },
    {
      "ruleType": "DENY",
      "applicationType": "SIGNATURE",
      "catId": "128",
      "appId": "1",
      "priority": 2
    },
    {
      "ruleType": "QOS",
      "applicationType": "SIGNATURE",
      "catId": "168",
      "appId": "2",
      "markingPriority": "IEEE802_1p",
      "markingType": "VOICE",
      "classificationType": "VOICE",
      "priority": 3
    },
    {
      "ruleType": "RATE_LIMITING",
      "applicationType": "SIGNATURE",
      "catId": "168",
      "appId": "3",
      "uplink": 1000,
      "downlink": 2000,
      "priority": 4
    }
  ],
  "avcLogEnable": false,
  "avcEventEnable": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "description": "Identifier of the System (root) domain or partner managed domain to which the Application Policy Profile belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the Application Policy Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Application Policy Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "applicationRules": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "type": "integer"
          },
          "ruleType": {
            "description": "Type of the application rule",
            "type": "string",
            "enum": [
              "DENY",
              "QOS",
              "RATE_LIMITING"
            ]
          },
          "applicationType": {
            "description": "Type of the application when ruleType",
            "type": "string",
            "enum": [
              "SIGNATURE",
              "USER_DEFINED"
            ]
          },
          "catId": {
            "description": "Identifier of the Application Category from Signature Package (If applicationType is UserDefind, the catId is 32768)",
            "type": "string"
          },
          "catName": {
            "description": "Name of the Application Category from Signature Package",
            "type": "string"
          },
          "appId": {
            "description": "Identifier of the Application from Signature Package",
            "type": "string"
          },
          "appName": {
            "description": "Name of the Application from Signature Package",
            "type": "string"
          },
          "uplink": {
            "description": "Uplink rate limiting (unit: Kbps)",
            "type": "integer"
          },
          "downlink": {
            "description": "Downlink rate limiting (unit: Kbps)",
            "type": "integer"
          },
          "markingPriority": {
            "description": "QoS uplink marking priority",
            "type": "string",
            "enum": [
              "IEEE802_1p",
              "DSCP",
              "BOTH"
            ]
          },
          "markingType": {
            "description": "QoS uplink marking type",
            "type": "string",
            "enum": [
              "VOICE",
              "VIDEO",
              "BEST_EFFORT",
              "BACKGROUND"
            ]
          },
          "classificationType": {
            "description": "QoS downlink classification type",
            "type": "string",
            "enum": [
              "VOICE",
              "VIDEO",
              "BEST_EFFORT",
              "BACKGROUND"
            ]
          }
        }
      }
    },
    "avcLogEnable": {
      "description": "Send ARC logs from AP to external syslog server",
      "type": "boolean"
    },
    "avcEventEnable": {
      "description": "Send ARC logs from AP to SmartZone",
      "type": "boolean"
    }
  },
  "required": [
    "name",
    "applicationRules"
  ]
}
Response  201
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Application Policy V2 Create

POST/v11_1/avc/applicationPolicyV2

Use this API command to create a new AVC Application Policy profile.

Request
HideShow
Body
{
  "name": "aa",
  "description": "",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "applicationRules": [
    {
      "ruleType": "DENY",
      "applicationType": "USER_DEFINED",
      "catId": "32768",
      "appId": "2",
      "priority": 1
    },
    {
      "ruleType": "DENY",
      "applicationType": "SIGNATURE",
      "catId": "128",
      "appId": "1",
      "priority": 2
    },
    {
      "ruleType": "QOS",
      "applicationType": "SIGNATURE",
      "catId": "168",
      "appId": "2",
      "markingPriority": "IEEE802_1p",
      "markingType": "VOICE",
      "classificationType": "VOICE",
      "priority": 3
    },
    {
      "ruleType": "RATE_LIMITING",
      "applicationType": "SIGNATURE",
      "catId": "168",
      "appId": "3",
      "uplink": 1000,
      "downlink": 2000,
      "priority": 4
    }
  ],
  "avcLogEnable": false,
  "avcEventEnable": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "description": "Identifier of the System (root) domain or partner managed domain to which the Application Policy Profile belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the Application Policy Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Application Policy Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "applicationRules": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "type": "integer"
          },
          "ruleType": {
            "description": "Type of the application rule",
            "type": "string",
            "enum": [
              "DENY",
              "QOS",
              "RATE_LIMITING"
            ]
          },
          "applicationType": {
            "description": "Type of the application when ruleType",
            "type": "string",
            "enum": [
              "SIGNATURE",
              "USER_DEFINED"
            ]
          },
          "catId": {
            "description": "Identifier of the Application Category from Signature Package (If applicationType is UserDefind, the catId is 32768)",
            "type": "string"
          },
          "catName": {
            "description": "Name of the Application Category from Signature Package",
            "type": "string"
          },
          "appId": {
            "description": "Identifier of the Application from Signature Package",
            "type": "string"
          },
          "appName": {
            "description": "Name of the Application from Signature Package",
            "type": "string"
          },
          "uplink": {
            "description": "Uplink rate limiting (unit: Kbps)",
            "type": "integer"
          },
          "downlink": {
            "description": "Downlink rate limiting (unit: Kbps)",
            "type": "integer"
          },
          "markingPriority": {
            "description": "QoS uplink marking priority",
            "type": "string",
            "enum": [
              "IEEE802_1p",
              "DSCP",
              "BOTH"
            ]
          },
          "markingType": {
            "description": "QoS uplink marking type",
            "type": "string",
            "enum": [
              "VOICE",
              "VIDEO",
              "BEST_EFFORT",
              "BACKGROUND"
            ]
          },
          "classificationType": {
            "description": "QoS downlink classification type",
            "type": "string",
            "enum": [
              "VOICE",
              "VIDEO",
              "BEST_EFFORT",
              "BACKGROUND"
            ]
          }
        }
      }
    },
    "avcLogEnable": {
      "description": "Send ARC logs from AP to external syslog server",
      "type": "boolean"
    },
    "avcEventEnable": {
      "description": "Send ARC logs from AP to SmartZone",
      "type": "boolean"
    }
  },
  "required": [
    "name",
    "applicationRules"
  ]
}
Response  201
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Upload File

POST/v11_1/avc/signaturePackage/upload

Update AVC Signature Package by upload file (for 5.0 and Earlier Firmware Versions).

Request
HideShow
Headers
Content-Type: multipart/form-data
Response  200
HideShow
Body
{
  "id": "acc29c30-ee35-11e4-8c03-000c292547b9",
  "fileName": "RuckusSigPack-1.005",
  "size": "629145",
  "version": "1.5",
  "binariesInfo": [
    {
      "fileName": "ppc-lib.tar.gz",
      "size": 3343608,
      "type": "CLASSIFICATION",
      "platform": "PPC"
    },
    {
      "fileName": "arm-lib.tar.gz",
      "size": 3391401,
      "type": "CLASSIFICATION",
      "platform": "ARM"
    },
    {
      "fileName": "mips-lib.tar.gz",
      "size": 3539066,
      "type": "CLASSIFICATION",
      "platform": "MIPS"
    },
    {
      "fileName": "arm-regular-lib.tar.gz",
      "size": 4945412,
      "type": "REGULAR",
      "platform": "ARM"
    }
  ],
  "checkLatestInstallableSettings": {
    "checkEnabled": true,
    "dateOfMonth": 1
  },
  "latestInstallable": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the Signature Package",
      "type": "string"
    },
    "fileName": {
      "description": "Name of the Signature Package",
      "type": "string"
    },
    "version": {
      "description": "Version of the Signature Package",
      "type": "string"
    },
    "size": {
      "description": "Size of the Signature Package",
      "type": "integer",
      "format": "int64"
    },
    "binariesInfo": {
      "description": "General information about the binary files in the Signature Package",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "fileName": {
            "description": "File name of the Signature Package Binary",
            "type": "string"
          },
          "platform": {
            "description": "AP platform the Signature Package Binary supports",
            "type": "string",
            "enum": [
              "CLASSIFICATION",
              "REGULAR"
            ]
          },
          "type": {
            "description": "Type of the Signature Package Binary",
            "type": "string",
            "enum": [
              "ARM",
              "PPC",
              "MIPS"
            ]
          },
          "size": {
            "description": "The size of signature package binary file",
            "type": "integer"
          }
        }
      }
    },
    "checkLatestInstallableSettings": {
      "description": "Configurable settings for checking if there exists latest installable Signature Package for download in the support site",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "checkEnabled": {
          "description": "Enable or disable the periodic check for latest installable signature package",
          "type": "boolean"
        },
        "dateOfMonth": {
          "description": "date of the month",
          "type": "integer",
          "minimum": 1,
          "maximum": 31
        }
      }
    },
    "latestInstallable": {
      "description": "The latest installable Signature Package that fits this SZ for download in the support site",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "description": "The version of the latest installable signature package",
          "type": "string"
        },
        "binariesInfo": {
          "description": "The binaries information of the latest installable signature package",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "fileName": {
                "description": "File name of the latest installable Signature Package Binary",
                "type": "string"
              },
              "platform": {
                "description": "AP platform the latest installable Signature Package Binary supports",
                "type": "string",
                "enum": [
                  "CLASSIFICATION",
                  "REGULAR"
                ]
              },
              "type": {
                "description": "Type of the latest installable Signature Package Binary",
                "type": "string",
                "enum": [
                  "ARM",
                  "PPC",
                  "MIPS"
                ]
              }
            }
          }
        },
        "lastCheckedTime": {
          "description": "The last checked time for the latest installable signature package",
          "type": "integer"
        }
      }
    }
  }
}

User Defined Create

POST/v11_1/avc/userDefined

Use this API command to create a new AVC User Defined profile.

Request
HideShow
Body
{
  "name": "postman-c",
  "type": "IP_WITH_PORT",
  "destIp": "11.22.33.44",
  "netmask": "255.255.255.0",
  "destPort": 22,
  "protocol": "TCP"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "description": "Identifier of the System (root) domain or partner managed domain to which the User Defined Application belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the User Defined Application Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "type": {
      "description": "Type of the User Defined Application",
      "type": "string",
      "enum": [
        "IP_WITH_PORT",
        "PORT_ONLY"
      ]
    },
    "destIp": {
      "description": "Destination Server IP",
      "type": "string"
    },
    "netmask": {
      "description": "Netmask of User Defined Application",
      "type": "string",
      "pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
    },
    "destPort": {
      "description": "Destination Port of User Defined Application",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "protocol": {
      "description": "Protocol of User Defined Application",
      "type": "string",
      "enum": [
        "TCP",
        "UDP"
      ]
    }
  },
  "required": [
    "name",
    "type",
    "destPort",
    "protocol"
  ]
}
Response  201
HideShow
Body
{
  "id": "05f0503b-cfd9-414e-b37d-72a96f0f4288"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Upload File

POST/v11_1/avc/signaturePackageV2/upload

Update AVC Signature Package by upload file.

Request
HideShow
Headers
Content-Type: multipart/form-data
Response  200
HideShow
Body
{
  "id": "acc29c30-ee35-11e4-8c03-000c292547b9",
  "fileName": "RuckusSigPack-1.005",
  "size": "629145",
  "version": "1.5",
  "binariesInfo": [
    {
      "fileName": "ppc-lib.tar.gz",
      "size": 3343608,
      "type": "CLASSIFICATION",
      "platform": "PPC"
    },
    {
      "fileName": "arm-lib.tar.gz",
      "size": 3391401,
      "type": "CLASSIFICATION",
      "platform": "ARM"
    },
    {
      "fileName": "mips-lib.tar.gz",
      "size": 3539066,
      "type": "CLASSIFICATION",
      "platform": "MIPS"
    },
    {
      "fileName": "arm-regular-lib.tar.gz",
      "size": 4945412,
      "type": "REGULAR",
      "platform": "ARM"
    }
  ],
  "checkLatestInstallableSettings": {
    "checkEnabled": true,
    "dateOfMonth": 1
  },
  "latestInstallable": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the Signature Package",
      "type": "string"
    },
    "fileName": {
      "description": "Name of the Signature Package",
      "type": "string"
    },
    "version": {
      "description": "Version of the Signature Package",
      "type": "string"
    },
    "size": {
      "description": "Size of the Signature Package",
      "type": "integer",
      "format": "int64"
    },
    "binariesInfo": {
      "description": "General information about the binary files in the Signature Package",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "fileName": {
            "description": "File name of the Signature Package Binary",
            "type": "string"
          },
          "platform": {
            "description": "AP platform the Signature Package Binary supports",
            "type": "string",
            "enum": [
              "CLASSIFICATION",
              "REGULAR"
            ]
          },
          "type": {
            "description": "Type of the Signature Package Binary",
            "type": "string",
            "enum": [
              "ARM",
              "PPC",
              "MIPS"
            ]
          },
          "size": {
            "description": "The size of signature package binary file",
            "type": "integer"
          }
        }
      }
    },
    "checkLatestInstallableSettings": {
      "description": "Configurable settings for checking if there exists latest installable Signature Package for download in the support site",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "checkEnabled": {
          "description": "Enable or disable the periodic check for latest installable signature package",
          "type": "boolean"
        },
        "dateOfMonth": {
          "description": "date of the month",
          "type": "integer",
          "minimum": 1,
          "maximum": 31
        }
      }
    },
    "latestInstallable": {
      "description": "The latest installable Signature Package that fits this SZ for download in the support site",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "description": "The version of the latest installable signature package",
          "type": "string"
        },
        "binariesInfo": {
          "description": "The binaries information of the latest installable signature package",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "fileName": {
                "description": "File name of the latest installable Signature Package Binary",
                "type": "string"
              },
              "platform": {
                "description": "AP platform the latest installable Signature Package Binary supports",
                "type": "string",
                "enum": [
                  "CLASSIFICATION",
                  "REGULAR"
                ]
              },
              "type": {
                "description": "Type of the latest installable Signature Package Binary",
                "type": "string",
                "enum": [
                  "ARM",
                  "PPC",
                  "MIPS"
                ]
              }
            }
          }
        },
        "lastCheckedTime": {
          "description": "The last checked time for the latest installable signature package",
          "type": "integer"
        }
      }
    }
  }
}

Check Latest Signature Package

POST/v11_1/avc/signaturePackageV2/checkLatest

Check latest Signature Package from Ruckus support site and get latest Signature Package info.

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "version": {
      "description": "The version of the latest installable signature package",
      "type": "string"
    },
    "binariesInfo": {
      "description": "The binaries information of the latest installable signature package",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "fileName": {
            "description": "File name of the latest installable Signature Package Binary",
            "type": "string"
          },
          "platform": {
            "description": "AP platform the latest installable Signature Package Binary supports",
            "type": "string",
            "enum": [
              "CLASSIFICATION",
              "REGULAR"
            ]
          },
          "type": {
            "description": "Type of the latest installable Signature Package Binary",
            "type": "string",
            "enum": [
              "ARM",
              "PPC",
              "MIPS"
            ]
          }
        }
      }
    },
    "lastCheckedTime": {
      "description": "The last checked time for the latest installable signature package",
      "type": "integer"
    }
  }
}

Download and Install

POST/v11_1/avc/signaturePackageV2/downloadAndInstallLastChecked

Download Signature Package from Ruckus support site and install.

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "message": {
      "description": "The message of current download process",
      "type": "string"
    },
    "state": {
      "description": "The state of current download process",
      "type": "string"
    },
    "latestInstallable": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "description": "The version of the latest installable signature package",
          "type": "string"
        },
        "binariesInfo": {
          "description": "The binaries information of the latest installable signature package",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "fileName": {
                "description": "File name of the latest installable Signature Package Binary",
                "type": "string"
              },
              "platform": {
                "description": "AP platform the latest installable Signature Package Binary supports",
                "type": "string",
                "enum": [
                  "CLASSIFICATION",
                  "REGULAR"
                ]
              },
              "type": {
                "description": "Type of the latest installable Signature Package Binary",
                "type": "string",
                "enum": [
                  "ARM",
                  "PPC",
                  "MIPS"
                ]
              }
            }
          }
        },
        "lastCheckedTime": {
          "description": "The last checked time for the latest installable signature package",
          "type": "integer"
        }
      }
    }
  }
}

User Defined Retrieve List

POST/v11_1/query/userDefined

Use this API command to retrieve a list of AVC User Defined profiles. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "name": "ip-and-port",
      "type": "IP_WITH_PORT",
      "id": "acc29c30-ee35-11e4-8c03-000c292547b9",
      "appId": 1,
      "domainId": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722",
      "destIp": "11.22.33.44",
      "netmask": "255.255.255.0",
      "destPort": 22,
      "protocol": "TCP"
    },
    {
      "name": "port-only",
      "type": "PORT_ONLY",
      "id": "ba7b3fb0-f2fb-11e4-b680-80fa5b024259",
      "appId": 1,
      "domainId": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722",
      "destPort": 99,
      "protocol": "UDP"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "Extra information for user defined policy",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the User Defined Application",
            "type": "string"
          },
          "appId": {
            "description": "AppId for Application Policy's User defined rule type",
            "type": "integer"
          },
          "tenantId": {
            "description": "Tenant Id",
            "type": "string"
          },
          "domainId": {
            "description": "Identifier of the System (root) domain or partner managed domain to which the User Defined Application belongs",
            "type": "string"
          },
          "name": {
            "description": "Name of the User Defined Application Profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "type": {
            "description": "Type of the User Defined Application",
            "type": "string",
            "enum": [
              "IP_WITH_PORT",
              "PORT_ONLY"
            ]
          },
          "destIp": {
            "description": "Destination Server IP",
            "type": "string"
          },
          "netmask": {
            "description": "Netmask of User Defined Application",
            "type": "string",
            "pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
          },
          "destPort": {
            "description": "Destination Port of User Defined Application",
            "type": "integer",
            "minimum": 1,
            "maximum": 65535
          },
          "protocol": {
            "description": "Protocol of User Defined Application",
            "type": "string",
            "enum": [
              "TCP",
              "UDP"
            ]
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Application Policy Retrieve List

POST/v11_1/query/applicationPolicy

Use this API command to retrieve a list of AVC Application Policy profiles (for 5.0 and Earlier Firmware Versions). Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "name": "postman-dp-c",
      "id": "ba7b3fb0-f2fb-11e4-b680-80fa5b024259",
      "description": "postman-dp-c",
      "domainId": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722",
      "applicationRules": [
        {
          "ruleType": "DENY",
          "applicationType": "SIGNATURE",
          "catId": "126",
          "appId": "1"
        }
      ],
      "avcLogEnable": false,
      "avcEventEnable": false
    },
    {
      "name": "test2",
      "id": "0a782052-96d5-738b-afce-aa8157abd30c",
      "description": "test-2",
      "domainId": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722",
      "applicationRules": [
        {
          "ruleType": "QOS",
          "applicationType": "SIGNATURE",
          "catId": "126",
          "appId": "1",
          "markingPriority": "DSCP",
          "markingType": "VOICE",
          "classificationType": "VOICE"
        }
      ],
      "avcLogEnable": false,
      "avcEventEnable": false
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "Extra information for application policy",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the Application Policy Profile",
            "type": "string"
          },
          "tenantId": {
            "description": "Tenant Id",
            "type": "string"
          },
          "domainId": {
            "description": "Identifier of the System (root) domain or partner managed domain to which the Application Policy Profile belongs",
            "type": "string"
          },
          "name": {
            "description": "Name of the Application Policy Profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the Application Policy Profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "applicationRules": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "priority": {
                  "type": "integer"
                },
                "ruleType": {
                  "description": "Type of the application rule",
                  "type": "string",
                  "enum": [
                    "DENY",
                    "QOS",
                    "RATE_LIMITING"
                  ]
                },
                "applicationType": {
                  "description": "Type of the application when ruleType",
                  "type": "string",
                  "enum": [
                    "SIGNATURE",
                    "USER_DEFINED"
                  ]
                },
                "catId": {
                  "description": "Identifier of the Application Category from Signature Package (If applicationType is UserDefind, the catId is 32768)",
                  "type": "string"
                },
                "catName": {
                  "description": "Name of the Application Category from Signature Package",
                  "type": "string"
                },
                "appId": {
                  "description": "Identifier of the Application from Signature Package",
                  "type": "string"
                },
                "appName": {
                  "description": "Name of the Application from Signature Package",
                  "type": "string"
                },
                "uplink": {
                  "description": "Uplink rate limiting (unit: Kbps)",
                  "type": "integer"
                },
                "downlink": {
                  "description": "Downlink rate limiting (unit: Kbps)",
                  "type": "integer"
                },
                "markingPriority": {
                  "description": "QoS uplink marking priority",
                  "type": "string",
                  "enum": [
                    "IEEE802_1p",
                    "DSCP",
                    "BOTH"
                  ]
                },
                "markingType": {
                  "description": "QoS uplink marking type",
                  "type": "string",
                  "enum": [
                    "VOICE",
                    "VIDEO",
                    "BEST_EFFORT",
                    "BACKGROUND"
                  ]
                },
                "classificationType": {
                  "description": "QoS downlink classification type",
                  "type": "string",
                  "enum": [
                    "VOICE",
                    "VIDEO",
                    "BEST_EFFORT",
                    "BACKGROUND"
                  ]
                }
              }
            }
          },
          "avcLogEnable": {
            "description": "Send ARC logs from AP to external syslog server",
            "type": "boolean"
          },
          "avcEventEnable": {
            "description": "Send ARC logs from AP to SmartZone",
            "type": "boolean"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Application Policy V2 Retrieve List

POST/v11_1/query/applicationPolicyV2

Use this API command to retrieve a list of AVC Application Policy profiles. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "name": "postman-dp-c",
      "id": "ba7b3fb0-f2fb-11e4-b680-80fa5b024259",
      "description": "postman-dp-c",
      "domainId": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722",
      "applicationRules": [
        {
          "ruleType": "DENY",
          "applicationType": "SIGNATURE",
          "catId": "126",
          "appId": "1"
        }
      ],
      "avcLogEnable": false,
      "avcEventEnable": false
    },
    {
      "name": "test2",
      "id": "0a782052-96d5-738b-afce-aa8157abd30c",
      "description": "test-2",
      "domainId": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722",
      "applicationRules": [
        {
          "ruleType": "QOS",
          "applicationType": "SIGNATURE",
          "catId": "126",
          "appId": "1",
          "markingPriority": "DSCP",
          "markingType": "VOICE",
          "classificationType": "VOICE"
        }
      ],
      "avcLogEnable": false,
      "avcEventEnable": false
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "Extra information for application policy",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the Application Policy Profile",
            "type": "string"
          },
          "tenantId": {
            "description": "Tenant Id",
            "type": "string"
          },
          "domainId": {
            "description": "Identifier of the System (root) domain or partner managed domain to which the Application Policy Profile belongs",
            "type": "string"
          },
          "name": {
            "description": "Name of the Application Policy Profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the Application Policy Profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "applicationRules": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "priority": {
                  "type": "integer"
                },
                "ruleType": {
                  "description": "Type of the application rule",
                  "type": "string",
                  "enum": [
                    "DENY",
                    "QOS",
                    "RATE_LIMITING"
                  ]
                },
                "applicationType": {
                  "description": "Type of the application when ruleType",
                  "type": "string",
                  "enum": [
                    "SIGNATURE",
                    "USER_DEFINED"
                  ]
                },
                "catId": {
                  "description": "Identifier of the Application Category from Signature Package (If applicationType is UserDefind, the catId is 32768)",
                  "type": "string"
                },
                "catName": {
                  "description": "Name of the Application Category from Signature Package",
                  "type": "string"
                },
                "appId": {
                  "description": "Identifier of the Application from Signature Package",
                  "type": "string"
                },
                "appName": {
                  "description": "Name of the Application from Signature Package",
                  "type": "string"
                },
                "uplink": {
                  "description": "Uplink rate limiting (unit: Kbps)",
                  "type": "integer"
                },
                "downlink": {
                  "description": "Downlink rate limiting (unit: Kbps)",
                  "type": "integer"
                },
                "markingPriority": {
                  "description": "QoS uplink marking priority",
                  "type": "string",
                  "enum": [
                    "IEEE802_1p",
                    "DSCP",
                    "BOTH"
                  ]
                },
                "markingType": {
                  "description": "QoS uplink marking type",
                  "type": "string",
                  "enum": [
                    "VOICE",
                    "VIDEO",
                    "BEST_EFFORT",
                    "BACKGROUND"
                  ]
                },
                "classificationType": {
                  "description": "QoS downlink classification type",
                  "type": "string",
                  "enum": [
                    "VOICE",
                    "VIDEO",
                    "BEST_EFFORT",
                    "BACKGROUND"
                  ]
                }
              }
            }
          },
          "avcLogEnable": {
            "description": "Send ARC logs from AP to external syslog server",
            "type": "boolean"
          },
          "avcEventEnable": {
            "description": "Send ARC logs from AP to SmartZone",
            "type": "boolean"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Update Signature Package Settings

PATCH/v11_1/avc/signaturePackageV2

Use this API command to update Signature Package related settings

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "checkLatestInstallableSettings": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "checkEnabled": {
          "description": "Enable or disable the periodic check for latest installable signature package",
          "type": "boolean"
        },
        "dateOfMonth": {
          "description": "date of the month",
          "type": "integer",
          "minimum": 1,
          "maximum": 31
        }
      }
    }
  }
}
Response  200

Application Policy Modify

PATCH/v11_1/avc/applicationPolicy/{id}

Use this API command to modify the configuration on AVC Application Policy profile (for 5.0 and Earlier Firmware Versions).

Request
HideShow
Body
{
  "name": "aa",
  "description": "",
  "applicationRules": [
    {
      "priority": 1,
      "ruleType": "QOS",
      "applicationType": "SIGNATURE",
      "catId": "128",
      "appId": "2",
      "markingPriority": "IEEE802_1p",
      "markingType": "VOICE",
      "classificationType": "VOICE"
    },
    {
      "priority": 2,
      "ruleType": "DENY",
      "applicationType": "USER_DEFINED",
      "catId": "32768",
      "appId": "2"
    },
    {
      "priority": 3,
      "ruleType": "DENY",
      "applicationType": "SIGNATURE",
      "catId": "128",
      "appId": "1"
    }
  ],
  "avcLogEnable": false,
  "avcEventEnable": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Application Policy Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Application Policy Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "applicationRules": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "type": "integer"
          },
          "ruleType": {
            "description": "Type of the application rule",
            "type": "string",
            "enum": [
              "DENY",
              "QOS",
              "RATE_LIMITING"
            ]
          },
          "applicationType": {
            "description": "Type of the application when ruleType",
            "type": "string",
            "enum": [
              "SIGNATURE",
              "USER_DEFINED"
            ]
          },
          "catId": {
            "description": "Identifier of the Application Category from Signature Package (If applicationType is UserDefind, the catId is 32768)",
            "type": "string"
          },
          "catName": {
            "description": "Name of the Application Category from Signature Package",
            "type": "string"
          },
          "appId": {
            "description": "Identifier of the Application from Signature Package",
            "type": "string"
          },
          "appName": {
            "description": "Name of the Application from Signature Package",
            "type": "string"
          },
          "uplink": {
            "description": "Uplink rate limiting (unit: Kbps)",
            "type": "integer"
          },
          "downlink": {
            "description": "Downlink rate limiting (unit: Kbps)",
            "type": "integer"
          },
          "markingPriority": {
            "description": "QoS uplink marking priority",
            "type": "string",
            "enum": [
              "IEEE802_1p",
              "DSCP",
              "BOTH"
            ]
          },
          "markingType": {
            "description": "QoS uplink marking type",
            "type": "string",
            "enum": [
              "VOICE",
              "VIDEO",
              "BEST_EFFORT",
              "BACKGROUND"
            ]
          },
          "classificationType": {
            "description": "QoS downlink classification type",
            "type": "string",
            "enum": [
              "VOICE",
              "VIDEO",
              "BEST_EFFORT",
              "BACKGROUND"
            ]
          }
        }
      }
    },
    "avcLogEnable": {
      "description": "Send ARC logs from AP to external syslog server",
      "type": "boolean"
    },
    "avcEventEnable": {
      "description": "Send ARC logs from AP to SmartZone",
      "type": "boolean"
    }
  }
}
Response  204

Application Policy V2 Modify

PATCH/v11_1/avc/applicationPolicyV2/{id}

Use this API command to modify the configuration on AVC Application Policy profile.

Request
HideShow
Body
{
  "name": "aa",
  "description": "",
  "applicationRules": [
    {
      "priority": 1,
      "ruleType": "QOS",
      "applicationType": "SIGNATURE",
      "catId": "128",
      "appId": "2",
      "markingPriority": "IEEE802_1p",
      "markingType": "VOICE",
      "classificationType": "VOICE"
    },
    {
      "priority": 2,
      "ruleType": "DENY",
      "applicationType": "USER_DEFINED",
      "catId": "32768",
      "appId": "2"
    },
    {
      "priority": 3,
      "ruleType": "DENY",
      "applicationType": "SIGNATURE",
      "catId": "128",
      "appId": "1"
    }
  ],
  "avcLogEnable": false,
  "avcEventEnable": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Application Policy Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Application Policy Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "applicationRules": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "type": "integer"
          },
          "ruleType": {
            "description": "Type of the application rule",
            "type": "string",
            "enum": [
              "DENY",
              "QOS",
              "RATE_LIMITING"
            ]
          },
          "applicationType": {
            "description": "Type of the application when ruleType",
            "type": "string",
            "enum": [
              "SIGNATURE",
              "USER_DEFINED"
            ]
          },
          "catId": {
            "description": "Identifier of the Application Category from Signature Package (If applicationType is UserDefind, the catId is 32768)",
            "type": "string"
          },
          "catName": {
            "description": "Name of the Application Category from Signature Package",
            "type": "string"
          },
          "appId": {
            "description": "Identifier of the Application from Signature Package",
            "type": "string"
          },
          "appName": {
            "description": "Name of the Application from Signature Package",
            "type": "string"
          },
          "uplink": {
            "description": "Uplink rate limiting (unit: Kbps)",
            "type": "integer"
          },
          "downlink": {
            "description": "Downlink rate limiting (unit: Kbps)",
            "type": "integer"
          },
          "markingPriority": {
            "description": "QoS uplink marking priority",
            "type": "string",
            "enum": [
              "IEEE802_1p",
              "DSCP",
              "BOTH"
            ]
          },
          "markingType": {
            "description": "QoS uplink marking type",
            "type": "string",
            "enum": [
              "VOICE",
              "VIDEO",
              "BEST_EFFORT",
              "BACKGROUND"
            ]
          },
          "classificationType": {
            "description": "QoS downlink classification type",
            "type": "string",
            "enum": [
              "VOICE",
              "VIDEO",
              "BEST_EFFORT",
              "BACKGROUND"
            ]
          }
        }
      }
    },
    "avcLogEnable": {
      "description": "Send ARC logs from AP to external syslog server",
      "type": "boolean"
    },
    "avcEventEnable": {
      "description": "Send ARC logs from AP to SmartZone",
      "type": "boolean"
    }
  }
}
Response  204

User Defined Modify

PATCH/v11_1/avc/userDefined/{id}

Use this API command to modify the configuration on AVC User Defined profile.

Request
HideShow
Body
{
  "name": "test-modify",
  "destIp": "11.22.33.44",
  "netmask": "255.255.255.0",
  "destPort": 11,
  "protocol": "UDP"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the User Defined Application Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "type": {
      "description": "Type of the User Defined Application",
      "type": "string",
      "enum": [
        "IP_WITH_PORT",
        "PORT_ONLY"
      ]
    },
    "destIp": {
      "description": "Destination Server IP",
      "type": "string"
    },
    "netmask": {
      "description": "Netmask of User Defined Application",
      "type": "string",
      "pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
    },
    "destPort": {
      "description": "Destination Port of User Defined Application",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "protocol": {
      "description": "Protocol of User Defined Application",
      "type": "string",
      "enum": [
        "TCP",
        "UDP"
      ]
    }
  }
}
Response  204

User Defined Delete

DELETE/v11_1/avc/userDefined/{id}

Use this API command to delete a AVC User Defined Profile.

Response  204

User Defined Multiple Delete

DELETE/v11_1/avc/userDefined

Use this API command to delete a AVC User Defined Profile.

Request
HideShow
Body
{
  "idList": [
    "acc29c30-ee35-11e4-8c03-000c292547b9",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Application Policy Delete

DELETE/v11_1/avc/applicationPolicy/{id}

Use this API command to delete a AVC Application Policy Profile (for 5.0 and Earlier Firmware Versions).

Response  204

Application Policy Multiple Delete

DELETE/v11_1/avc/applicationPolicy

Use this API command to delete a AVC Application Policy Profile (for 5.0 and Earlier Firmware Versions).

Request
HideShow
Body
{
  "idList": [
    "acc29c30-ee35-11e4-8c03-000c292547b9",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200

Application Policy V2 Delete

DELETE/v11_1/avc/applicationPolicyV2/{id}

Use this API command to delete a AVC Application Policy Profile.

Response  204

Application Policy V2 Multiple Delete

DELETE/v11_1/avc/applicationPolicyV2

Use this API command to delete a AVC Application Policy Profile.

Request
HideShow
Body
{
  "idList": [
    "acc29c30-ee35-11e4-8c03-000c292547b9",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200

URL Filtering Policy

Retrieve URL Filtering policy List

GET/v11_1/urlFiltering/urlFilteringPolicy

Use this API command to retrieve list of URL Filtering policies.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

domainId
string (optional) 
Response  200
HideShow
Body
{
  "extra": null,
  "firstIndex": 0,
  "hasMore": false,
  "list": [
    {
      "blacklist": [],
      "blockCategories": [
        48,
        10,
        70,
        36
      ],
      "description": "Created from PublicAPI directly.",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "filteringLevel": "CHILD_AND_STUDENT_FRIENDLY",
      "id": "f32246c0-5013-11e7-b6be-525400a0e6c5",
      "name": "test00001",
      "safeSearchBingDns": null,
      "safeSearchBingEnabled": false,
      "safeSearchEnabled": true,
      "safeSearchGoogleDns": null,
      "safeSearchGoogleEnabled": true,
      "safeSearchYouTubeDns": null,
      "safeSearchYouTubeEnabled": false,
      "whiteList": [
        "172.17.99.91"
      ],
      "blockByThreatLevelConfig": {
        "webReputationScore": "SUSPICIOUS"
      }
    },
    {
      "blacklist": [
        "www.facebook.com"
      ],
      "blockCategories": [
        48,
        10,
        70
      ],
      "description": "Created from PublicAPI directly.",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "filteringLevel": "CHILD_AND_STUDENT_FRIENDLY",
      "id": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
      "name": "test00002",
      "safeSearchBingDns": null,
      "safeSearchBingEnabled": false,
      "safeSearchEnabled": true,
      "safeSearchGoogleDns": "8.8.8.8",
      "safeSearchGoogleEnabled": true,
      "safeSearchYouTubeDns": null,
      "safeSearchYouTubeEnabled": false,
      "whiteList": [],
      "blockByThreatLevelConfig": {
        "webReputationScore": "SUSPICIOUS"
      }
    }
  ],
  "totalCount": 2
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for URL Filtering policy",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the URL Filtering policy",
            "type": "string"
          },
          "tenantId": {
            "description": "Tenant Id",
            "type": "string"
          },
          "domainId": {
            "description": "Identifier of the System (root) domain or partner managed domain to which the URL filtering policy belongs",
            "type": "string"
          },
          "name": {
            "description": "Name of the URL Filtering policy",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the URL Filtering policy",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "filteringLevel": {
            "description": "The filtering level of the URL Filtering policy",
            "type": "string",
            "enum": [
              "NO_ADULT",
              "CLEAN_AND_SAFE",
              "CHILD_AND_STUDENT_FRIENDLY",
              "STRICT",
              "CUSTOM"
            ]
          },
          "blockCategories": {
            "description": "The block category IDs of the URL Filtering policy",
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "safeSearchGoogleEnabled": {
            "description": "Enable Google safe search of the URL Filtering policy",
            "type": "boolean"
          },
          "safeSearchGoogleDns": {
            "description": "Google DNS for safe search of the URL Filtering policy",
            "type": "string"
          },
          "safeSearchYouTubeEnabled": {
            "description": "Enable YouTube safe search of the URL Filtering policy",
            "type": "boolean"
          },
          "safeSearchYouTubeDns": {
            "description": "YouTube DNS for safe search of the URL Filtering policy",
            "type": "string"
          },
          "safeSearchBingEnabled": {
            "description": "Enable Bing safe search of the URL Filtering policy",
            "type": "boolean"
          },
          "safeSearchBingDns": {
            "description": "Bing DNS for safe search of the URL Filtering policy",
            "type": "string"
          },
          "whitelist": {
            "description": "The whitelist of the URL Filtering policy",
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 0,
              "maxLength": 64
            }
          },
          "blacklist": {
            "description": "The blacklist of the URL Filtering policy",
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 0,
              "maxLength": 64
            }
          },
          "blockByThreatLevelConfig": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "webReputationScore": {
                "description": "User can set web reputation score as HIGH_RISK(20), SUSPICIOUS(40), MODERATE_RISK(60), LOW_RISK(80) or TRUSTWORTHY(100). When setting as HIGH_RISK, all the high risk will be blocked",
                "type": "string",
                "enum": [
                  "HIGH_RISK",
                  "SUSPICIOUS",
                  "MODERATE_RISK",
                  "LOW_RISK",
                  "TRUSTWORTHY"
                ]
              }
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve URL Filtering policy

GET/v11_1/urlFiltering/urlFilteringPolicy/{id}

Use this API command to retrieve an URL Filtering policy.

Response  200
HideShow
Body
{
  "blacklist": [
    "www.facebook.com"
  ],
  "blockCategories": [
    48,
    10,
    70
  ],
  "createDateTime": 1497344072091,
  "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "creatorUsername": "admin",
  "description": "Created from PublicAPI directly.",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "filteringLevel": "CHILD_AND_STUDENT_FRIENDLY",
  "id": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
  "modifiedDateTime": 1497344072091,
  "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "modifierUsername": "admin",
  "name": "test00002",
  "safeSearchBingDns": null,
  "safeSearchBingEnabled": false,
  "safeSearchEnabled": true,
  "safeSearchGoogleDns": "8.8.8.8",
  "safeSearchGoogleEnabled": true,
  "safeSearchYouTubeDns": null,
  "safeSearchYouTubeEnabled": false,
  "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "whitelist": [],
  "blockByThreatLevelConfig": {
    "webReputationScore": "SUSPICIOUS"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the URL Filtering policy",
      "type": "string"
    },
    "tenantId": {
      "description": "Tenant Id",
      "type": "string"
    },
    "domainId": {
      "description": "Identifier of the System (root) domain or partner managed domain to which the URL filtering policy belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the URL Filtering policy",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the URL Filtering policy",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "filteringLevel": {
      "description": "The filtering level of the URL Filtering policy",
      "type": "string",
      "enum": [
        "NO_ADULT",
        "CLEAN_AND_SAFE",
        "CHILD_AND_STUDENT_FRIENDLY",
        "STRICT",
        "CUSTOM"
      ]
    },
    "blockCategories": {
      "description": "The block category IDs of the URL Filtering policy",
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "safeSearchGoogleEnabled": {
      "description": "Enable Google safe search of the URL Filtering policy",
      "type": "boolean"
    },
    "safeSearchGoogleDns": {
      "description": "Google DNS for safe search of the URL Filtering policy",
      "type": "string"
    },
    "safeSearchYouTubeEnabled": {
      "description": "Enable YouTube safe search of the URL Filtering policy",
      "type": "boolean"
    },
    "safeSearchYouTubeDns": {
      "description": "YouTube DNS for safe search of the URL Filtering policy",
      "type": "string"
    },
    "safeSearchBingEnabled": {
      "description": "Enable Bing safe search of the URL Filtering policy",
      "type": "boolean"
    },
    "safeSearchBingDns": {
      "description": "Bing DNS for safe search of the URL Filtering policy",
      "type": "string"
    },
    "whitelist": {
      "description": "The whitelist of the URL Filtering policy",
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 0,
        "maxLength": 64
      }
    },
    "blacklist": {
      "description": "The blacklist of the URL Filtering policy",
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 0,
        "maxLength": 64
      }
    },
    "blockByThreatLevelConfig": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "webReputationScore": {
          "description": "User can set web reputation score as HIGH_RISK(20), SUSPICIOUS(40), MODERATE_RISK(60), LOW_RISK(80) or TRUSTWORTHY(100). When setting as HIGH_RISK, all the high risk will be blocked",
          "type": "string",
          "enum": [
            "HIGH_RISK",
            "SUSPICIOUS",
            "MODERATE_RISK",
            "LOW_RISK",
            "TRUSTWORTHY"
          ]
        }
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Retrieve block categories of URL Filtering

GET/v11_1/urlFiltering/blockCategories

Use this API command to retrieve the block categories of URL Filtering.

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the URL Filtering Category",
            "type": "integer"
          },
          "name": {
            "description": "name of the URL Filtering Category",
            "type": "string"
          }
        }
      }
    }
  }
}

Create URL Filtering policy

POST/v11_1/urlFiltering/urlFilteringPolicy

Use this API command to create a URL Filtering policy.

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "test00002",
  "description": "Created from PublicAPI directly.",
  "filteringLevel": "CHILD_AND_STUDENT_FRIENDLY",
  "blockCategories": [
    48,
    10,
    70
  ],
  "blacklist": [
    "www.facebook.com"
  ],
  "safeSearchGoogleEnabled": true,
  "safeSearchGoogleDns": "8.8.8.8",
  "blockByThreatLevelConfig": {
    "webReputationScore": "SUSPICIOUS"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "description": "Identifier of the System (root) domain or partner managed domain to which the URL filtering policy belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the URL Filtering policy",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the URL Filtering policy",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "filteringLevel": {
      "description": "The filtering level of the URL Filtering policy",
      "type": "string",
      "enum": [
        "NO_ADULT",
        "CLEAN_AND_SAFE",
        "CHILD_AND_STUDENT_FRIENDLY",
        "STRICT",
        "CUSTOM"
      ]
    },
    "blockCategories": {
      "description": "The block category IDs of the URL Filtering policy",
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "safeSearchGoogleEnabled": {
      "description": "Enable Google safe search of the URL Filtering policy",
      "type": "boolean"
    },
    "safeSearchGoogleDns": {
      "description": "Google DNS for safe search of the URL Filtering policy",
      "type": "string"
    },
    "safeSearchYouTubeEnabled": {
      "description": "Enable YouTube safe search of the URL Filtering policy",
      "type": "boolean"
    },
    "safeSearchYouTubeDns": {
      "description": "YouTube DNS for safe search of the URL Filtering policy",
      "type": "string"
    },
    "safeSearchBingEnabled": {
      "description": "Enable Bing safe search of the URL Filtering policy",
      "type": "boolean"
    },
    "safeSearchBingDns": {
      "description": "Bing DNS for safe search of the URL Filtering policy",
      "type": "string"
    },
    "whitelist": {
      "description": "The whitelist of the URL Filtering policy",
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 0,
        "maxLength": 64
      }
    },
    "blacklist": {
      "description": "The blacklist of the URL Filtering policy",
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 0,
        "maxLength": 64
      }
    },
    "blockByThreatLevelConfig": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "webReputationScore": {
          "description": "User can set web reputation score as HIGH_RISK(20), SUSPICIOUS(40), MODERATE_RISK(60), LOW_RISK(80) or TRUSTWORTHY(100). When setting as HIGH_RISK, all the high risk will be blocked",
          "type": "string",
          "enum": [
            "HIGH_RISK",
            "SUSPICIOUS",
            "MODERATE_RISK",
            "LOW_RISK",
            "TRUSTWORTHY"
          ]
        }
      }
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": "eac50e51-4a63-11e7-a68a-0a0027000000"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Retrieve URL Filtering policies List by query criteria

POST/v11_1/urlFiltering/query

Use this API command to retrieve a list of URL Filtering policies by query criteria. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "extra": null,
  "firstIndex": 0,
  "hasMore": false,
  "list": [
    {
      "blacklist": [],
      "blockCategories": [
        48,
        10,
        70,
        36
      ],
      "description": "Created from PublicAPI directly.",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "filteringLevel": "CHILD_AND_STUDENT_FRIENDLY",
      "id": "f32246c0-5013-11e7-b6be-525400a0e6c5",
      "name": "test00001",
      "safeSearchBingDns": null,
      "safeSearchBingEnabled": false,
      "safeSearchEnabled": true,
      "safeSearchGoogleDns": null,
      "safeSearchGoogleEnabled": true,
      "safeSearchYouTubeDns": null,
      "safeSearchYouTubeEnabled": false,
      "whiteList": [
        "172.17.99.91"
      ],
      "blockByThreatLevelConfig": {
        "webReputationScore": "SUSPICIOUS"
      }
    },
    {
      "blacklist": [
        "www.facebook.com"
      ],
      "blockCategories": [
        48,
        10,
        70
      ],
      "description": "Created from PublicAPI directly.",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "filteringLevel": "CHILD_AND_STUDENT_FRIENDLY",
      "id": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
      "name": "test00002",
      "safeSearchBingDns": null,
      "safeSearchBingEnabled": false,
      "safeSearchEnabled": true,
      "safeSearchGoogleDns": "8.8.8.8",
      "safeSearchGoogleEnabled": true,
      "safeSearchYouTubeDns": null,
      "safeSearchYouTubeEnabled": false,
      "whiteList": [],
      "blockByThreatLevelConfig": {
        "webReputationScore": "SUSPICIOUS"
      }
    }
  ],
  "totalCount": 2
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for URL Filtering policy",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the URL Filtering policy",
            "type": "string"
          },
          "tenantId": {
            "description": "Tenant Id",
            "type": "string"
          },
          "domainId": {
            "description": "Identifier of the System (root) domain or partner managed domain to which the URL filtering policy belongs",
            "type": "string"
          },
          "name": {
            "description": "Name of the URL Filtering policy",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the URL Filtering policy",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "filteringLevel": {
            "description": "The filtering level of the URL Filtering policy",
            "type": "string",
            "enum": [
              "NO_ADULT",
              "CLEAN_AND_SAFE",
              "CHILD_AND_STUDENT_FRIENDLY",
              "STRICT",
              "CUSTOM"
            ]
          },
          "blockCategories": {
            "description": "The block category IDs of the URL Filtering policy",
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "safeSearchGoogleEnabled": {
            "description": "Enable Google safe search of the URL Filtering policy",
            "type": "boolean"
          },
          "safeSearchGoogleDns": {
            "description": "Google DNS for safe search of the URL Filtering policy",
            "type": "string"
          },
          "safeSearchYouTubeEnabled": {
            "description": "Enable YouTube safe search of the URL Filtering policy",
            "type": "boolean"
          },
          "safeSearchYouTubeDns": {
            "description": "YouTube DNS for safe search of the URL Filtering policy",
            "type": "string"
          },
          "safeSearchBingEnabled": {
            "description": "Enable Bing safe search of the URL Filtering policy",
            "type": "boolean"
          },
          "safeSearchBingDns": {
            "description": "Bing DNS for safe search of the URL Filtering policy",
            "type": "string"
          },
          "whitelist": {
            "description": "The whitelist of the URL Filtering policy",
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 0,
              "maxLength": 64
            }
          },
          "blacklist": {
            "description": "The blacklist of the URL Filtering policy",
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 0,
              "maxLength": 64
            }
          },
          "blockByThreatLevelConfig": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "webReputationScore": {
                "description": "User can set web reputation score as HIGH_RISK(20), SUSPICIOUS(40), MODERATE_RISK(60), LOW_RISK(80) or TRUSTWORTHY(100). When setting as HIGH_RISK, all the high risk will be blocked",
                "type": "string",
                "enum": [
                  "HIGH_RISK",
                  "SUSPICIOUS",
                  "MODERATE_RISK",
                  "LOW_RISK",
                  "TRUSTWORTHY"
                ]
              }
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Modify URL Filtering policy

PUT/v11_1/urlFiltering/urlFilteringPolicy/{id}

Use this API command to modify a URL Filtering policy.

Request
HideShow
Body
{
  "name": "testURLFilteringPolicy33",
  "description": "Modified from PublicAPI directly.",
  "filteringLevel": "CLEAN_AND_SAFE",
  "blockCategories": [
    2,
    8,
    5,
    13,
    56
  ],
  "blockByThreatLevelConfig": {
    "webReputationScore": "SUSPICIOUS"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the URL Filtering policy",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the URL Filtering policy",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "filteringLevel": {
      "description": "The filtering level of the URL Filtering policy",
      "type": "string",
      "enum": [
        "NO_ADULT",
        "CLEAN_AND_SAFE",
        "CHILD_AND_STUDENT_FRIENDLY",
        "STRICT",
        "CUSTOM"
      ]
    },
    "blockCategories": {
      "description": "The block category IDs of the URL Filtering policy",
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "safeSearchGoogleEnabled": {
      "description": "Enable Google safe search of the URL Filtering policy",
      "type": "boolean"
    },
    "safeSearchGoogleDns": {
      "description": "Google DNS for safe search of the URL Filtering policy",
      "type": "string"
    },
    "safeSearchYouTubeEnabled": {
      "description": "Enable YouTube safe search of the URL Filtering policy",
      "type": "boolean"
    },
    "safeSearchYouTubeDns": {
      "description": "YouTube DNS for safe search of the URL Filtering policy",
      "type": "string"
    },
    "safeSearchBingEnabled": {
      "description": "Enable Bing safe search of the URL Filtering policy",
      "type": "boolean"
    },
    "safeSearchBingDns": {
      "description": "Bing DNS for safe search of the URL Filtering policy",
      "type": "string"
    },
    "whitelist": {
      "description": "The whitelist of the URL Filtering policy",
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 0,
        "maxLength": 64
      }
    },
    "blacklist": {
      "description": "The blacklist of the URL Filtering policy",
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 0,
        "maxLength": 64
      }
    },
    "blockByThreatLevelConfig": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "webReputationScore": {
          "description": "User can set web reputation score as HIGH_RISK(20), SUSPICIOUS(40), MODERATE_RISK(60), LOW_RISK(80) or TRUSTWORTHY(100). When setting as HIGH_RISK, all the high risk will be blocked",
          "type": "string",
          "enum": [
            "HIGH_RISK",
            "SUSPICIOUS",
            "MODERATE_RISK",
            "LOW_RISK",
            "TRUSTWORTHY"
          ]
        }
      }
    }
  }
}
Response  204

Patch URL Filtering policy

PATCH/v11_1/urlFiltering/urlFilteringPolicy/{id}

Use this API command to patch a URL Filtering policy.

Request
HideShow
Body
{
  "name": "testURLFilteringPolicy33",
  "description": "Modified from PublicAPI directly.",
  "filteringLevel": "CLEAN_AND_SAFE",
  "blockCategories": [
    2,
    8,
    5,
    13,
    56
  ],
  "blockByThreatLevelConfig": {
    "webReputationScore": "SUSPICIOUS"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the URL Filtering policy",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the URL Filtering policy",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "filteringLevel": {
      "description": "The filtering level of the URL Filtering policy",
      "type": "string",
      "enum": [
        "NO_ADULT",
        "CLEAN_AND_SAFE",
        "CHILD_AND_STUDENT_FRIENDLY",
        "STRICT",
        "CUSTOM"
      ]
    },
    "blockCategories": {
      "description": "The block category IDs of the URL Filtering policy",
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "safeSearchGoogleEnabled": {
      "description": "Enable Google safe search of the URL Filtering policy",
      "type": "boolean"
    },
    "safeSearchGoogleDns": {
      "description": "Google DNS for safe search of the URL Filtering policy",
      "type": "string"
    },
    "safeSearchYouTubeEnabled": {
      "description": "Enable YouTube safe search of the URL Filtering policy",
      "type": "boolean"
    },
    "safeSearchYouTubeDns": {
      "description": "YouTube DNS for safe search of the URL Filtering policy",
      "type": "string"
    },
    "safeSearchBingEnabled": {
      "description": "Enable Bing safe search of the URL Filtering policy",
      "type": "boolean"
    },
    "safeSearchBingDns": {
      "description": "Bing DNS for safe search of the URL Filtering policy",
      "type": "string"
    },
    "whitelist": {
      "description": "The whitelist of the URL Filtering policy",
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 0,
        "maxLength": 64
      }
    },
    "blacklist": {
      "description": "The blacklist of the URL Filtering policy",
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 0,
        "maxLength": 64
      }
    },
    "blockByThreatLevelConfig": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "webReputationScore": {
          "description": "User can set web reputation score as HIGH_RISK(20), SUSPICIOUS(40), MODERATE_RISK(60), LOW_RISK(80) or TRUSTWORTHY(100). When setting as HIGH_RISK, all the high risk will be blocked",
          "type": "string",
          "enum": [
            "HIGH_RISK",
            "SUSPICIOUS",
            "MODERATE_RISK",
            "LOW_RISK",
            "TRUSTWORTHY"
          ]
        }
      }
    }
  }
}
Response  204

Delete URL Filtering policy

DELETE/v11_1/urlFiltering/urlFilteringPolicy/{id}

Use this API command to delete a URL Filtering policy.

Response  204

Delete bulk URL Filtering policy

DELETE/v11_1/urlFiltering/urlFilteringPolicy

Use this API command to delete bulk URL Filtering policies.

Request
HideShow
Body
{
  "idList": [
    "eac50e51-4a63-11e7-a68a-0a0027000000",
    "1b4950d1-49d9-11e7-a68a-0a0027000000"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200

Wi-Fi Calling Policy

Retrieve List of Wi-Fi Calling Policy.

GET/v11_1/wifiCalling/wifiCallingPolicy

Use this API command to Retrieve List of Wi-Fi Calling Policy.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

domainId
string (optional) 

Hi joe, please check.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "extra": {
    "rbacMetadata": [
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      },
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      }
    ]
  },
  "list": [
    {
      "name": "TMobil",
      "id": "8c3beb81-e859-11e7-8c35-08002748d78e",
      "description": "",
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "priority": "VOICE",
      "epdgs": [
        {
          "fqdn": "tmobil.epdg1.com",
          "ip": ""
        }
      ],
      "modifiedDateTime": 1514085696057,
      "modifierUsername": "admin",
      "createDateTime": 1514085696057,
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "creatorUsername": "admin"
    },
    {
      "name": "att",
      "id": "72758fd0-e859-11e7-8c35-08002748d78e",
      "description": "",
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "priority": "VOICE",
      "epdgs": [
        {
          "fqdn": "att.epdg2.com",
          "ip": "2.2.2.2"
        },
        {
          "fqdn": "att.epdg1.com",
          "ip": ""
        }
      ],
      "modifiedDateTime": 1514085652813,
      "modifierUsername": "admin",
      "createDateTime": 1514085652813,
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "creatorUsername": "admin"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "domainId": {
            "description": "Identifier of the System (root) domain or partner managed domain to which the Wi-Fi calling policy belongs",
            "type": "string"
          },
          "id": {
            "description": "Identifier of the Wi-Fi calling policy",
            "type": "string"
          },
          "tenantId": {
            "description": "Tenant Id",
            "type": "string"
          },
          "name": {
            "description": "Name of the Wi-Fi calling policy",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the Wi-Fi calling policy",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "priority": {
            "description": "QoS priority of the Wi-Fi calling policy",
            "type": "string",
            "enum": [
              "BACKGROUND",
              "BEST_EFFORT",
              "VIDEO",
              "VOICE"
            ]
          },
          "epdgs": {
            "description": "ePDG list of the Wi-Fi calling policy",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "fqdn": {
                  "description": "Fully qualified domain name of ePDG",
                  "type": "string"
                },
                "ip": {
                  "type": "string"
                }
              }
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve Wi-Fi Calling Policy.

GET/v11_1/wifiCalling/wifiCallingPolicy/{id}

Use this API command to Retrieve Wi-Fi Calling Policy.

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "description": "Identifier of the System (root) domain or partner managed domain to which the Wi-Fi calling policy belongs",
      "type": "string"
    },
    "id": {
      "description": "Identifier of the Wi-Fi calling policy",
      "type": "string"
    },
    "tenantId": {
      "description": "Tenant Id",
      "type": "string"
    },
    "name": {
      "description": "Name of the Wi-Fi calling policy",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Wi-Fi calling policy",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "priority": {
      "description": "QoS priority of the Wi-Fi calling policy",
      "type": "string",
      "enum": [
        "BACKGROUND",
        "BEST_EFFORT",
        "VIDEO",
        "VOICE"
      ]
    },
    "epdgs": {
      "description": "ePDG list of the Wi-Fi calling policy",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "fqdn": {
            "description": "Fully qualified domain name of ePDG",
            "type": "string"
          },
          "ip": {
            "type": "string"
          }
        }
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Query Wi-Fi Calling Policy List.

POST/v11_1/wifiCalling/query

Use this API command to Query Wi-Fi Calling Policy List. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "extra": {
    "rbacMetadata": [
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      },
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      }
    ]
  },
  "list": [
    {
      "name": "TMobil",
      "id": "8c3beb81-e859-11e7-8c35-08002748d78e",
      "description": "",
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "priority": "VOICE",
      "epdgs": [
        {
          "fqdn": "tmobil.epdg1.com",
          "ip": ""
        }
      ],
      "modifiedDateTime": 1514085696057,
      "modifierUsername": "admin",
      "createDateTime": 1514085696057,
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "creatorUsername": "admin"
    },
    {
      "name": "att",
      "id": "72758fd0-e859-11e7-8c35-08002748d78e",
      "description": "",
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "priority": "VOICE",
      "epdgs": [
        {
          "fqdn": "att.epdg2.com",
          "ip": "2.2.2.2"
        },
        {
          "fqdn": "att.epdg1.com",
          "ip": ""
        }
      ],
      "modifiedDateTime": 1514085652813,
      "modifierUsername": "admin",
      "createDateTime": 1514085652813,
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "creatorUsername": "admin"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "domainId": {
            "description": "Identifier of the System (root) domain or partner managed domain to which the Wi-Fi calling policy belongs",
            "type": "string"
          },
          "id": {
            "description": "Identifier of the Wi-Fi calling policy",
            "type": "string"
          },
          "tenantId": {
            "description": "Tenant Id",
            "type": "string"
          },
          "name": {
            "description": "Name of the Wi-Fi calling policy",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the Wi-Fi calling policy",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "priority": {
            "description": "QoS priority of the Wi-Fi calling policy",
            "type": "string",
            "enum": [
              "BACKGROUND",
              "BEST_EFFORT",
              "VIDEO",
              "VOICE"
            ]
          },
          "epdgs": {
            "description": "ePDG list of the Wi-Fi calling policy",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "fqdn": {
                  "description": "Fully qualified domain name of ePDG",
                  "type": "string"
                },
                "ip": {
                  "type": "string"
                }
              }
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Create Wi-Fi Calling Policy.

POST/v11_1/wifiCalling/wifiCallingPolicy

Use this API command to Create Wi-Fi Calling Policy.

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "joe-test",
  "description": "",
  "priority": "VIDEO",
  "epdgs": [
    {
      "fqdn": "joe.epdg.com",
      "ip": "1.2.2.2"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "description": "Identifier of the System (root) domain or partner managed domain to which the Wi-Fi calling policy belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the Wi-Fi calling policy",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Wi-Fi calling policy",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "priority": {
      "description": "QoS priority of the Wi-Fi calling policy",
      "type": "string",
      "enum": [
        "BACKGROUND",
        "BEST_EFFORT",
        "VIDEO",
        "VOICE"
      ]
    },
    "epdgs": {
      "description": "ePDG list of the Wi-Fi calling policy",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "fqdn": {
            "description": "Fully qualified domain name of ePDG",
            "type": "string"
          },
          "ip": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "name",
    "priority",
    "epdgs"
  ]
}
Response  201
HideShow
Body
{
  "id": "72758fd0-e859-11e7-8c35-08002748d78e"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Entire Wi-Fi Calling policy.

PUT/v11_1/wifiCalling/wifiCallingPolicy/{id}

Use this API command to Modify Entire Wi-Fi Calling policy.

Request
HideShow
Body
{
  "name": "joe-test2",
  "priority": "VOICE",
  "epdgs": [
    {
      "fqdn": "joe.epdg2.com",
      "ip": "1.2.2.2"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Wi-Fi calling policy",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Wi-Fi calling policy",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "priority": {
      "description": "QoS priority of the Wi-Fi calling policy",
      "type": "string",
      "enum": [
        "BACKGROUND",
        "BEST_EFFORT",
        "VIDEO",
        "VOICE"
      ]
    },
    "epdgs": {
      "description": "ePDG list of the Wi-Fi calling policy",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "fqdn": {
            "description": "Fully qualified domain name of ePDG",
            "type": "string"
          },
          "ip": {
            "type": "string"
          }
        }
      }
    }
  }
}
Response  204

Modify a Wi-Fi Calling policy.

PATCH/v11_1/wifiCalling/wifiCallingPolicy/{id}

Use this API command to Modify a Wi-Fi Calling policy.

Request
HideShow
Body
{
  "name": "joe-test2",
  "priority": "VOICE",
  "epdgs": [
    {
      "fqdn": "joe.epdg2.com",
      "ip": "1.2.2.2"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Wi-Fi calling policy",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Wi-Fi calling policy",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "priority": {
      "description": "QoS priority of the Wi-Fi calling policy",
      "type": "string",
      "enum": [
        "BACKGROUND",
        "BEST_EFFORT",
        "VIDEO",
        "VOICE"
      ]
    },
    "epdgs": {
      "description": "ePDG list of the Wi-Fi calling policy",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "fqdn": {
            "description": "Fully qualified domain name of ePDG",
            "type": "string"
          },
          "ip": {
            "type": "string"
          }
        }
      }
    }
  }
}
Response  204

Delete a Wi-Fi Calling policy by ID.

DELETE/v11_1/wifiCalling/wifiCallingPolicy/{id}

Use this API command to Delete a Wi-Fi Calling policy by ID.

Response  204

Delete bulk Wi-Fi Calling policies.

DELETE/v11_1/wifiCalling/wifiCallingPolicy

Use this API command to Delete bulk Wi-Fi Calling policies.

Request
HideShow
Body
{
  "idList": [
    "72758fd0-e859-11e7-8c35-08002748d78e",
    "8c3beb81-e859-11e7-8c35-08002748d78e"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200

Ethernet Port Profile

Retrieve List - Ethernet Port Porfile

GET/v11_1/rkszones/{zoneId}/profile/ethernetPort

Retrieve a list of Ethernet Port Porfiles within a zone.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "0",
      "name": "Default Trunk Port"
    },
    {
      "id": "1",
      "name": "Default Access Port"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the service",
            "type": "string"
          },
          "name": {
            "description": "Name of the service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          }
        }
      }
    }
  }
}

Retrieve - Ethernet Port Porfile

GET/v11_1/rkszones/{zoneId}/profile/ethernetPort/{id}

Retrieve a Ethernet Port Porfile.

Response  200
HideShow
Body
{
  "name": "ethport",
  "id": "13",
  "description": "ethportDesc",
  "type": "AccessPort",
  "tunnelEnabled": true,
  "tunnelProfile": {
    "id": "1fee12a1-ef8e-11e7-8d6f-08002748d78e",
    "name": "softGre1"
  },
  "untagId": 1,
  "vlanMembers": "1",
  "dynamicVlanEnabled": false,
  "guestVlan": null,
  "antiSpoofingEnabled": true,
  "arpRequestRateLimit": 15,
  "dhcpRequestRateLimit": 15,
  "userSidePortEnabled": true,
  "userSidePortMaxClient": 8,
  "_8021X": {
    "type": "Disable",
    "authenticator": null,
    "supplicant": null
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "identifier of the ethernet port profile",
      "type": "string"
    },
    "name": {
      "description": "name of the ethernet port profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the ethernet port profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "type": {
      "description": "type of the ethernet port profile",
      "type": "string",
      "enum": [
        "AccessPort",
        "TrunkPort",
        "GeneralPort"
      ]
    },
    "tunnelEnabled": {
      "description": "tunnelEnabled of the ethernet port profile for AccessPort type",
      "type": "boolean"
    },
    "accessNetworkType": {
      "description": "Access network type of the ethernet port profile",
      "type": "string",
      "enum": [
        "WAN",
        "TUNNEL",
        "LAN"
      ]
    },
    "untagId": {
      "description": "VLAN Untag ID of the ethernet port profile",
      "type": "integer",
      "minimum": 1,
      "maximum": 4094
    },
    "vlanMembers": {
      "description": "VLAN Members of the ethernet port profile",
      "type": "string"
    },
    "dynamicVlanEnabled": {
      "type": "boolean"
    },
    "guestVlan": {
      "type": "integer",
      "minimum": 1,
      "maximum": 4094
    },
    "qinq": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "cvlan": {
          "type": "integer",
          "minimum": 2,
          "maximum": 4094
        },
        "svlan": {
          "type": "integer",
          "minimum": 2,
          "maximum": 4094
        }
      }
    },
    "antiSpoofingEnabled": {
      "description": "Anti-Spoofing enabled",
      "type": "boolean"
    },
    "arpRequestRateLimit": {
      "description": "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    },
    "dhcpRequestRateLimit": {
      "description": "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    },
    "userSidePortEnabled": {
      "description": "User side port enabled.",
      "type": "boolean",
      "default": false
    },
    "userSidePortMaxClient": {
      "description": "Number of wired clients allowed to connect to a particular user side port, default value will be 8 if the value not being set.",
      "type": "integer",
      "minimum": 1,
      "maximum": 32,
      "default": 8
    },
    "userSidePortUplinkLimit": {
      "description": "Uplink rate limiting range should be 1 ~ 1000 Mbps. 0 means rate limiting uplink is disabled.",
      "minimum": 0,
      "maximum": 1000,
      "default": 0,
      "type": "integer"
    },
    "userSidePortDownlinkLimit": {
      "description": "Downlink rate limiting range should be 1 ~ 1000 Mbps. 0 means rate limiting downlink is disabled.",
      "minimum": 0,
      "maximum": 1000,
      "default": 0,
      "type": "integer"
    },
    "_8021X": {
      "description": "VLAN 802.1X of the ethernet port profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Disable",
            "Supplicant",
            "PortBasedAuthenticator",
            "MACBasedAuthenticator",
            "RoleOpen"
          ]
        },
        "authenticator": {
          "type": [
            "object",
            "null"
          ],
          "additionalProperties": false,
          "properties": {
            "authentication": {
              "type": [
                "object",
                "null"
              ],
              "additionalProperties": false,
              "properties": {
                "enableUseSCGasProxy": {
                  "type": "boolean"
                },
                "server": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "additionalProperties": false,
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "enableUseSCGasProxy"
              ]
            },
            "disabledAccounting": {
              "type": "boolean"
            },
            "accounting": {
              "description": "null mean Disabled",
              "type": [
                "object",
                "null"
              ],
              "additionalProperties": false,
              "properties": {
                "enableUseSCGasProxy": {
                  "type": "boolean"
                },
                "server": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "additionalProperties": false,
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "enableUseSCGasProxy"
              ]
            },
            "macAuthByPassEnabled": {
              "type": "boolean"
            }
          },
          "required": [
            "macAuthByPassEnabled"
          ]
        },
        "supplicant": {
          "type": [
            "object",
            "null"
          ],
          "additionalProperties": false,
          "properties": {
            "type": {
              "type": "string",
              "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"
      ]
    },
    "tunnelProfile": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ipsecProfile": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "firewallProfileId": {
      "description": "Firewall Profile Id",
      "type": "string"
    },
    "firewallAVCEnabled": {
      "description": "Application Recognition & Control enabled",
      "type": "boolean"
    },
    "firewallUrlFilteringPolicyEnabled": {
      "description": "URL Filtering Policy enabled",
      "type": "boolean"
    },
    "l2AccessControlPolicyId": {
      "description": "L2 Access Control Policy Id",
      "type": "string"
    },
    "clientIsolationEnabled": {
      "description": "Indicates whether wired client isolation is enabled or disabled",
      "type": "boolean",
      "default": false
    },
    "clientIsolationUnicastEnabled": {
      "description": "Indicates whether isolate unicast of wired client isolation is enabled or disabled",
      "type": "boolean",
      "default": true
    },
    "clientIsolationMulticastEnabled": {
      "description": "Indicates whether isolate multicast of wired client isolation is enabled or disabled",
      "type": "boolean"
    },
    "clientIsolationAutoVrrpEnabled": {
      "description": "Indicates whether Automatic support for VRRP of wired client isolation is enabled or disabled",
      "type": "boolean",
      "default": false
    },
    "clientIsolationWhitelist": {
      "description": "Indicates wired client isolation whitelist",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}

Retrieve Ethernet Port Profile List

POST/v11_1/query/services/ethernetPortProfile

Query Ethernet Port Profiles with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Create - Ethernet Port Porfile

POST/v11_1/rkszones/{zoneId}/profile/ethernetPort

Create a new Ethernet Port Porfile.

Request
HideShow
Body
{
  "name": "ethport",
  "description": "ethportDesc",
  "type": "AccessPort",
  "tunnelEnabled": true,
  "antiSpoofingEnabled": true,
  "arpRequestRateLimit": 15,
  "dhcpRequestRateLimit": 15,
  "userSidePortEnabled": true,
  "userSidePortMaxClient": 8,
  "_8021X": {
    "type": "Disable",
    "authenticator": null,
    "supplicant": null
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "name of the ethernet port profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the ethernet port profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "type": {
      "description": "type of the ethernet port profile",
      "type": "string",
      "enum": [
        "AccessPort",
        "TrunkPort",
        "GeneralPort"
      ],
      "default": "TrunkPort"
    },
    "tunnelEnabled": {
      "description": "tunnelEnabled of the ethernet port profile for AccessPort type",
      "type": "boolean",
      "default": false
    },
    "accessNetworkType": {
      "description": "Access network type of the ethernet port profile",
      "type": "string",
      "enum": [
        "WAN",
        "TUNNEL",
        "LAN"
      ]
    },
    "untagId": {
      "description": "VLAN Untag ID of the ethernet port profile",
      "type": "integer",
      "minimum": 1,
      "maximum": 4094,
      "default": 1
    },
    "vlanMembers": {
      "description": "VLAN Members of the ethernet port profile",
      "type": "string"
    },
    "dynamicVlanEnabled": {
      "type": "boolean"
    },
    "guestVlan": {
      "type": "integer",
      "minimum": 1,
      "maximum": 4094
    },
    "qinq": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "cvlan": {
          "type": "integer",
          "minimum": 2,
          "maximum": 4094
        },
        "svlan": {
          "type": "integer",
          "minimum": 2,
          "maximum": 4094
        }
      }
    },
    "antiSpoofingEnabled": {
      "description": "Anti-Spoofing enabled",
      "type": "boolean",
      "default": false
    },
    "arpRequestRateLimit": {
      "description": "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    },
    "dhcpRequestRateLimit": {
      "description": "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    },
    "userSidePortEnabled": {
      "description": "User side port enabled.",
      "type": "boolean",
      "default": false
    },
    "userSidePortMaxClient": {
      "description": "Number of wired clients allowed to connect to a particular user side port, default value will be 8 if the value not being set.",
      "type": "integer",
      "minimum": 1,
      "maximum": 32,
      "default": 8
    },
    "userSidePortUplinkLimit": {
      "description": "Uplink rate limiting range should be 1 ~ 1000 Mbps. 0 means rate limiting uplink is disabled.",
      "minimum": 0,
      "maximum": 1000,
      "default": 0,
      "type": "integer"
    },
    "userSidePortDownlinkLimit": {
      "description": "Downlink rate limiting range should be 1 ~ 1000 Mbps. 0 means rate limiting downlink is disabled.",
      "minimum": 0,
      "maximum": 1000,
      "default": 0,
      "type": "integer"
    },
    "_8021X": {
      "description": "VLAN 802.1X of the ethernet port profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Disable",
            "Supplicant",
            "PortBasedAuthenticator",
            "MACBasedAuthenticator",
            "RoleOpen"
          ]
        },
        "authenticator": {
          "type": [
            "object",
            "null"
          ],
          "additionalProperties": false,
          "properties": {
            "authentication": {
              "type": [
                "object",
                "null"
              ],
              "additionalProperties": false,
              "properties": {
                "enableUseSCGasProxy": {
                  "type": "boolean"
                },
                "server": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "additionalProperties": false,
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "enableUseSCGasProxy"
              ]
            },
            "disabledAccounting": {
              "type": "boolean"
            },
            "accounting": {
              "description": "null mean Disabled",
              "type": [
                "object",
                "null"
              ],
              "additionalProperties": false,
              "properties": {
                "enableUseSCGasProxy": {
                  "type": "boolean"
                },
                "server": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "additionalProperties": false,
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "enableUseSCGasProxy"
              ]
            },
            "macAuthByPassEnabled": {
              "type": "boolean"
            }
          },
          "required": [
            "macAuthByPassEnabled"
          ]
        },
        "supplicant": {
          "type": [
            "object",
            "null"
          ],
          "additionalProperties": false,
          "properties": {
            "type": {
              "type": "string",
              "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"
      ]
    },
    "tunnelProfile": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ipsecProfile": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "firewallProfileId": {
      "description": "Firewall Profile Id",
      "type": "string"
    },
    "firewallAVCEnabled": {
      "description": "Application Recognition & Control enabled",
      "type": "boolean"
    },
    "firewallUrlFilteringPolicyEnabled": {
      "description": "URL Filtering Policy enabled",
      "type": "boolean"
    },
    "l2AccessControlPolicyId": {
      "description": "L2 Access Control Policy Id",
      "type": "string"
    },
    "clientIsolationEnabled": {
      "description": "Indicates whether wired client isolation is enabled or disabled",
      "type": "boolean",
      "default": false
    },
    "clientIsolationUnicastEnabled": {
      "description": "Indicates whether isolate unicast of wired client isolation is enabled or disabled",
      "type": "boolean",
      "default": true
    },
    "clientIsolationMulticastEnabled": {
      "description": "Indicates whether isolate multicast of wired client isolation is enabled or disabled",
      "type": "boolean"
    },
    "clientIsolationAutoVrrpEnabled": {
      "description": "Indicates whether Automatic support for VRRP of wired client isolation is enabled or disabled",
      "type": "boolean",
      "default": false
    },
    "clientIsolationWhitelist": {
      "description": "Indicates wired client isolation whitelist",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "name",
    "type",
    "_8021X"
  ]
}
Response  201
HideShow
Body
{
  "id": "2"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Entire - Ethernet Port Porfile

PUT/v11_1/rkszones/{zoneId}/profile/ethernetPort/{id}

Modify a specific Ethernet Port Porfile.

Request
HideShow
Body
{
  "name": "modify-ethport",
  "description": "modify-ethport",
  "tunnelEnabled": false,
  "untagId": 1,
  "vlanMembers": "1-4094",
  "dynamicVlanEnabled": false,
  "guestVlan": 3,
  "antiSpoofingEnabled": true,
  "arpRequestRateLimit": 15,
  "dhcpRequestRateLimit": 15,
  "userSidePortEnabled": true,
  "userSidePortMaxClient": 8,
  "_8021X": {
    "type": "Supplicant",
    "authenticator": null,
    "supplicant": {
      "type": "Custom",
      "userName": "testuser",
      "password": "testpassword"
    }
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "name of the ethernet port profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the ethernet port profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "tunnelEnabled": {
      "description": "tunnelEnabled of the ethernet port profile for AccessPort type",
      "type": "boolean"
    },
    "accessNetworkType": {
      "description": "Access network type of the ethernet port profile",
      "type": "string",
      "enum": [
        "WAN",
        "TUNNEL",
        "LAN"
      ]
    },
    "untagId": {
      "description": "VLAN Untag ID of the ethernet port profile",
      "type": "integer",
      "minimum": 1,
      "maximum": 4094
    },
    "vlanMembers": {
      "description": "VLAN Members of the ethernet port profile",
      "type": "string"
    },
    "dynamicVlanEnabled": {
      "type": "boolean"
    },
    "guestVlan": {
      "type": "integer",
      "minimum": 1,
      "maximum": 4094
    },
    "qinq": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "cvlan": {
          "type": "integer",
          "minimum": 2,
          "maximum": 4094
        },
        "svlan": {
          "type": "integer",
          "minimum": 2,
          "maximum": 4094
        }
      }
    },
    "antiSpoofingEnabled": {
      "description": "Anti-Spoofing enabled",
      "type": "boolean"
    },
    "arpRequestRateLimit": {
      "description": "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    },
    "dhcpRequestRateLimit": {
      "description": "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    },
    "userSidePortEnabled": {
      "description": "User side port enabled.",
      "type": "boolean"
    },
    "userSidePortMaxClient": {
      "description": "Number of wired clients allowed to connect to a particular user side port, default value will be 8 if the value not being set.",
      "type": "integer",
      "minimum": 1,
      "maximum": 32
    },
    "userSidePortUplinkLimit": {
      "description": "Uplink rate limiting range should be 1 ~ 1000 Mbps. 0 means rate limiting uplink is disabled.",
      "minimum": 0,
      "maximum": 1000,
      "type": "integer"
    },
    "userSidePortDownlinkLimit": {
      "description": "Downlink rate limiting range should be 1 ~ 1000 Mbps. 0 means rate limiting downlink is disabled.",
      "minimum": 0,
      "maximum": 1000,
      "type": "integer"
    },
    "_8021X": {
      "description": "VLAN 802.1X of the ethernet port profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Disable",
            "Supplicant",
            "PortBasedAuthenticator",
            "MACBasedAuthenticator",
            "RoleOpen"
          ]
        },
        "authenticator": {
          "type": [
            "object",
            "null"
          ],
          "additionalProperties": false,
          "properties": {
            "authentication": {
              "type": [
                "object",
                "null"
              ],
              "additionalProperties": false,
              "properties": {
                "enableUseSCGasProxy": {
                  "type": "boolean"
                },
                "server": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "additionalProperties": false,
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "enableUseSCGasProxy"
              ]
            },
            "disabledAccounting": {
              "type": "boolean"
            },
            "accounting": {
              "description": "null mean Disabled",
              "type": [
                "object",
                "null"
              ],
              "additionalProperties": false,
              "properties": {
                "enableUseSCGasProxy": {
                  "type": "boolean"
                },
                "server": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "additionalProperties": false,
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "enableUseSCGasProxy"
              ]
            },
            "macAuthByPassEnabled": {
              "type": "boolean"
            }
          },
          "required": [
            "macAuthByPassEnabled"
          ]
        },
        "supplicant": {
          "type": [
            "object",
            "null"
          ],
          "additionalProperties": false,
          "properties": {
            "type": {
              "type": "string",
              "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"
      ]
    },
    "tunnelProfile": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ipsecProfile": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "firewallProfileId": {
      "description": "Firewall Profile Id",
      "type": "string"
    },
    "firewallAVCEnabled": {
      "description": "Application Recognition & Control enabled",
      "type": "boolean"
    },
    "firewallUrlFilteringPolicyEnabled": {
      "description": "URL Filtering Policy enabled",
      "type": "boolean"
    },
    "l2AccessControlPolicyId": {
      "description": "L2 Access Control Policy Id",
      "type": "string"
    },
    "clientIsolationEnabled": {
      "description": "Indicates whether wired client isolation is enabled or disabled",
      "type": "boolean"
    },
    "clientIsolationUnicastEnabled": {
      "description": "Indicates whether isolate unicast of wired client isolation is enabled or disabled",
      "type": "boolean"
    },
    "clientIsolationMulticastEnabled": {
      "description": "Indicates whether isolate multicast of wired client isolation is enabled or disabled",
      "type": "boolean"
    },
    "clientIsolationAutoVrrpEnabled": {
      "description": "Indicates whether Automatic support for VRRP of wired client isolation is enabled or disabled",
      "type": "boolean"
    },
    "clientIsolationWhitelist": {
      "description": "Indicates wired client isolation whitelist",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}
Response  204

Modify - Ethernet Port Porfile

PATCH/v11_1/rkszones/{zoneId}/profile/ethernetPort/{id}

Modify a specific Ethernet Port Porfile.

Request
HideShow
Body
{
  "name": "modify-ethport",
  "description": "modify-ethport",
  "tunnelEnabled": false,
  "untagId": 1,
  "vlanMembers": "1-4094",
  "dynamicVlanEnabled": false,
  "guestVlan": 3,
  "antiSpoofingEnabled": true,
  "arpRequestRateLimit": 15,
  "dhcpRequestRateLimit": 15,
  "userSidePortEnabled": true,
  "userSidePortMaxClient": 8,
  "_8021X": {
    "type": "Supplicant",
    "authenticator": null,
    "supplicant": {
      "type": "Custom",
      "userName": "testuser",
      "password": "testpassword"
    }
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "name of the ethernet port profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the ethernet port profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "tunnelEnabled": {
      "description": "tunnelEnabled of the ethernet port profile for AccessPort type",
      "type": "boolean"
    },
    "accessNetworkType": {
      "description": "Access network type of the ethernet port profile",
      "type": "string",
      "enum": [
        "WAN",
        "TUNNEL",
        "LAN"
      ]
    },
    "untagId": {
      "description": "VLAN Untag ID of the ethernet port profile",
      "type": "integer",
      "minimum": 1,
      "maximum": 4094
    },
    "vlanMembers": {
      "description": "VLAN Members of the ethernet port profile",
      "type": "string"
    },
    "dynamicVlanEnabled": {
      "type": "boolean"
    },
    "guestVlan": {
      "type": "integer",
      "minimum": 1,
      "maximum": 4094
    },
    "qinq": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "cvlan": {
          "type": "integer",
          "minimum": 2,
          "maximum": 4094
        },
        "svlan": {
          "type": "integer",
          "minimum": 2,
          "maximum": 4094
        }
      }
    },
    "antiSpoofingEnabled": {
      "description": "Anti-Spoofing enabled",
      "type": "boolean"
    },
    "arpRequestRateLimit": {
      "description": "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    },
    "dhcpRequestRateLimit": {
      "description": "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    },
    "userSidePortEnabled": {
      "description": "User side port enabled.",
      "type": "boolean"
    },
    "userSidePortMaxClient": {
      "description": "Number of wired clients allowed to connect to a particular user side port, default value will be 8 if the value not being set.",
      "type": "integer",
      "minimum": 1,
      "maximum": 32
    },
    "userSidePortUplinkLimit": {
      "description": "Uplink rate limiting range should be 1 ~ 1000 Mbps. 0 means rate limiting uplink is disabled.",
      "minimum": 0,
      "maximum": 1000,
      "type": "integer"
    },
    "userSidePortDownlinkLimit": {
      "description": "Downlink rate limiting range should be 1 ~ 1000 Mbps. 0 means rate limiting downlink is disabled.",
      "minimum": 0,
      "maximum": 1000,
      "type": "integer"
    },
    "_8021X": {
      "description": "VLAN 802.1X of the ethernet port profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Disable",
            "Supplicant",
            "PortBasedAuthenticator",
            "MACBasedAuthenticator",
            "RoleOpen"
          ]
        },
        "authenticator": {
          "type": [
            "object",
            "null"
          ],
          "additionalProperties": false,
          "properties": {
            "authentication": {
              "type": [
                "object",
                "null"
              ],
              "additionalProperties": false,
              "properties": {
                "enableUseSCGasProxy": {
                  "type": "boolean"
                },
                "server": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "additionalProperties": false,
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "enableUseSCGasProxy"
              ]
            },
            "disabledAccounting": {
              "type": "boolean"
            },
            "accounting": {
              "description": "null mean Disabled",
              "type": [
                "object",
                "null"
              ],
              "additionalProperties": false,
              "properties": {
                "enableUseSCGasProxy": {
                  "type": "boolean"
                },
                "server": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "additionalProperties": false,
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  }
                }
              },
              "required": [
                "enableUseSCGasProxy"
              ]
            },
            "macAuthByPassEnabled": {
              "type": "boolean"
            }
          },
          "required": [
            "macAuthByPassEnabled"
          ]
        },
        "supplicant": {
          "type": [
            "object",
            "null"
          ],
          "additionalProperties": false,
          "properties": {
            "type": {
              "type": "string",
              "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"
      ]
    },
    "tunnelProfile": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ipsecProfile": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "firewallProfileId": {
      "description": "Firewall Profile Id",
      "type": "string"
    },
    "firewallAVCEnabled": {
      "description": "Application Recognition & Control enabled",
      "type": "boolean"
    },
    "firewallUrlFilteringPolicyEnabled": {
      "description": "URL Filtering Policy enabled",
      "type": "boolean"
    },
    "l2AccessControlPolicyId": {
      "description": "L2 Access Control Policy Id",
      "type": "string"
    },
    "clientIsolationEnabled": {
      "description": "Indicates whether wired client isolation is enabled or disabled",
      "type": "boolean"
    },
    "clientIsolationUnicastEnabled": {
      "description": "Indicates whether isolate unicast of wired client isolation is enabled or disabled",
      "type": "boolean"
    },
    "clientIsolationMulticastEnabled": {
      "description": "Indicates whether isolate multicast of wired client isolation is enabled or disabled",
      "type": "boolean"
    },
    "clientIsolationAutoVrrpEnabled": {
      "description": "Indicates whether Automatic support for VRRP of wired client isolation is enabled or disabled",
      "type": "boolean"
    },
    "clientIsolationWhitelist": {
      "description": "Indicates wired client isolation whitelist",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}
Response  204

Delete - Ethernet Port Porfile

DELETE/v11_1/rkszones/{zoneId}/profile/ethernetPort/{id}

Delete Ethernet Port Porfile.

Response  204

Bond Port Profile

Retrieve List - Bond Port Profile

GET/v11_1/rkszones/{zoneId}/profile/bondPort

Retrieve a list of Bond Port Profiles within a zone.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "2b3772f2-0c70-4a99-b3f0-a86a5c7cc873",
      "name": "bondport_1",
      "isDefault": false
    },
    {
      "id": "2eced2da-0849-46d0-8351-78608f4a54ab",
      "name": "bondport_2",
      "isDefault": 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": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "isDefault": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Retrieve - Bond Port Profile

GET/v11_1/rkszones/{zoneId}/profile/bondPort/{id}

Retrieve a Bond Port Profile.

Response  200
HideShow
Body
{
  "id": "2b3772f2-0c70-4a99-b3f0-a86a5c7cc873",
  "name": "bondport_1",
  "description": "bondport_Desc",
  "type": "AccessPort",
  "untagId": 1,
  "vlanMembers": "1",
  "isDefault": false,
  "zoneId": "f5195fc4-df54-4dbf-bc13-fa766d1ccc67",
  "creatorUsername": "admin",
  "createDateTime": 1583732315225,
  "modifierUsername": "admin",
  "modifiedDateTime": 0
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "enum": [
        "AccessPort",
        "TrunkPort",
        "GeneralPort"
      ]
    },
    "untagId": {
      "type": "integer",
      "minimum": 1,
      "maximum": 4094
    },
    "vlanMembers": {
      "type": "string"
    },
    "isDefault": {
      "type": "boolean"
    },
    "zoneId": {
      "type": "string"
    },
    "createDateTime": {
      "type": "integer"
    },
    "modifiedDateTime": {
      "type": "integer"
    },
    "creatorUsername": {
      "type": "string"
    },
    "modifierUsername": {
      "type": "string"
    }
  }
}

Retrieve Bond Port Profile List

POST/v11_1/rkszones/bondPortProfiles/query

Query Bond Port Profiles with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 3,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "2b3772f2-0c70-4a99-b3f0-a86a5c7cc873",
      "name": "bondport_1",
      "description": "bondportDesc_1",
      "type": "AccessPort",
      "untagId": 1,
      "vlanMembers": "1",
      "isDefault": false,
      "zoneId": "f5195fc4-df54-4dbf-bc13-fa766d1ccc67",
      "creatorUsername": "admin",
      "createDateTime": 1583732315225,
      "modifierUsername": "admin",
      "modifiedDateTime": 0
    },
    {
      "id": "2eced2da-0849-46d0-8351-78608f4a54ab",
      "name": "bondport_2",
      "description": "bondportDesc_2",
      "type": "TrunkPort",
      "untagId": 1,
      "vlanMembers": "1-4094",
      "isDefault": false,
      "zoneId": "f5195fc4-df54-4dbf-bc13-fa766d1ccc67",
      "creatorUsername": "admin",
      "createDateTime": 1583732126665,
      "modifierUsername": "admin",
      "modifiedDateTime": 1583733080268
    },
    {
      "id": "a30dd9fe-14c6-4599-af24-b73dba44ee78",
      "name": "bondport_3",
      "description": "bondportDesc_3",
      "type": "GeneralPort",
      "untagId": 1,
      "vlanMembers": "2",
      "isDefault": false,
      "zoneId": "f5195fc4-df54-4dbf-bc13-fa766d1ccc67",
      "creatorUsername": "admin",
      "createDateTime": 1583732139195,
      "modifierUsername": "admin",
      "modifiedDateTime": 1583733285047
    }
  ],
  "extra": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "AccessPort",
              "TrunkPort",
              "GeneralPort"
            ]
          },
          "untagId": {
            "type": "integer",
            "minimum": 1,
            "maximum": 4094
          },
          "vlanMembers": {
            "type": "string"
          },
          "isDefault": {
            "type": "boolean"
          },
          "zoneId": {
            "type": "string"
          },
          "createDateTime": {
            "type": "integer"
          },
          "modifiedDateTime": {
            "type": "integer"
          },
          "creatorUsername": {
            "type": "string"
          },
          "modifierUsername": {
            "type": "string"
          }
        }
      }
    }
  }
}

Create - Bond Port Profile

POST/v11_1/rkszones/{zoneId}/profile/bondPort

Create a new Bond Port Profile.

Request
HideShow
Body
{
  "name": "bondport_2",
  "description": "bondportDesc_2",
  "type": "TrunkPort",
  "untagId": 1,
  "vlanMembers": "1-4094"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the bond port profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the bond port profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "type": {
      "description": "Type of the bond port profile",
      "type": "string",
      "enum": [
        "AccessPort",
        "TrunkPort",
        "GeneralPort"
      ],
      "default": "TrunkPort"
    },
    "untagId": {
      "description": "VLAN Untag ID of the bond port profile",
      "type": "integer",
      "minimum": 1,
      "maximum": 4094,
      "default": 1
    },
    "vlanMembers": {
      "description": "VLAN Members of the bond port profile",
      "type": "string"
    }
  },
  "required": [
    "name",
    "type",
    "untagId"
  ]
}
Response  200
HideShow
Body
{
  "id": "2eced2da-0849-46d0-8351-78608f4a54ab"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Entire - Bond Port Profile

PUT/v11_1/rkszones/{zoneId}/profile/bondPort/{id}

Modify a specific Bond Port Profile.

Request
HideShow
Body
{
  "name": "modify-bondport_2",
  "description": "modify-bondportDesc_2",
  "untagId": 2,
  "vlanMembers": "1-4094"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the bond port profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the bond port profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "untagId": {
      "description": "VLAN Untag ID of the bond port profile",
      "type": "integer",
      "minimum": 1,
      "maximum": 4094
    },
    "vlanMembers": {
      "description": "VLAN Members of the bond port profile",
      "type": "string"
    }
  },
  "required": [
    "untagId"
  ]
}
Response  204

Delete - Bond Port Profile

DELETE/v11_1/rkszones/{zoneId}/profile/bondPort/{id}

Delete Bond Port Profile.

Response  204

Delete - Multiple Bond Port Profile

DELETE/v11_1/rkszones/bondPortProfiles

Delete bulk Bond Port Profile.

Request
HideShow
Body
{
  "idList": [
    "eac50e51-4a63-11e7-a68a-0a0027000000",
    "1b4950d1-49d9-11e7-a68a-0a0027000000"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

VlanPooling

Retrieve

GET/v11_1/vlanpoolings/{id}

Use this API command to retrieve VLAN pooling.

Response  200
HideShow
Body
{
  "id": "d18e44e0-8af5-11e4-8155-000c299b4765",
  "name": "zoneVlanPooling",
  "description": "modify basic configuration",
  "domainId": "18b76a50-6a57-11e4-96af-dc6020524153",
  "pool": "3,12-18",
  "algo": "MAC_HASH"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the VLAN pooling profile",
      "type": "string"
    },
    "domainId": {
      "description": "Identifier of the domain which the VLAN pooling profile belongs to",
      "type": "string"
    },
    "name": {
      "description": "Name of the VLAN pooling profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the VLAN pooling profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "pool": {
      "description": "VLANs of the VLAN pooling profile",
      "type": "string"
    },
    "algo": {
      "description": "Algorithm of the VLAN pooling profile",
      "type": "string",
      "enum": [
        "MAC_HASH"
      ]
    }
  }
}

Retrieve Vlan Pooling Profile List

POST/v11_1/query/services/vlanPooling

Query Vlan Pooling Profiles with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200

Create

POST/v11_1/vlanpoolings

Use this API command to create new VLAN pooling.

Request
HideShow
Body
{
  "name": "vlan pooling-test",
  "description": "create description",
  "pool": "3,12-18",
  "algo": "MAC_HASH"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the VLAN pooling profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "domainId": {
      "description": "identifier of the domain",
      "type": "string"
    },
    "description": {
      "description": "Description of the VLAN pooling profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "pool": {
      "description": "VLANs of the VLAN pooling profile",
      "type": "string"
    },
    "algo": {
      "description": "Algorithm of the VLAN pooling profile",
      "default": "MAC_HASH",
      "type": "string",
      "enum": [
        "MAC_HASH"
      ]
    }
  },
  "required": [
    "name",
    "pool",
    "algo"
  ]
}
Response  201
HideShow
Body
{
  "id": "ffbcfde0-e9bf-11e6-b761-64006a6a50c6"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Retrieve List

POST/v11_1/vlanpoolings/query

Use this API command to retrieve a list of VLAN poolings. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "OR",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "name",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 10
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "ffbcfde0-e9bf-11e6-b761-64006a6a50c6",
      "name": "vlanPooling",
      "description": "",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "pool": "2",
      "algo": "MAC_HASH"
    }
  ],
  "extra": {
    "rbacMetadata": [
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      }
    ]
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for User Traffic profile",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the service",
            "type": "string"
          },
          "name": {
            "description": "Name of the service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "pool": {
            "description": "VLANs of the VLAN pooling profile",
            "type": "string"
          },
          "algo": {
            "description": "Algorithm of the VLAN pooling profile",
            "default": "MAC_HASH",
            "type": "string",
            "enum": [
              "MAC_HASH"
            ]
          },
          "domainId": {
            "description": "identifier of the domain",
            "type": "string"
          },
          "description": {
            "description": "Description of the service",
            "type": "string"
          }
        }
      }
    }
  }
}

Modify

PATCH/v11_1/vlanpoolings/{id}

Use this API command to modify the configuration on VLAN pooling.

Request
HideShow
Body
{
  "name": "VlanPooling",
  "description": "modify basic configuration",
  "pool": "20-26",
  "algo": "MAC_HASH"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the VLAN pooling profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the VLAN pooling profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "pool": {
      "description": "VLANs of the VLAN pooling profile",
      "type": "string"
    },
    "algo": {
      "description": "Algorithm of the VLAN pooling profile",
      "type": "string",
      "enum": [
        "MAC_HASH"
      ]
    },
    "domainId": {
      "description": "identifier of the domain",
      "type": "string"
    }
  }
}
Response  204

Delete

DELETE/v11_1/vlanpoolings/{id}

Use this API command to delete VLAN pooling.

Response  204

Bulk Delete Vlan Pooling

DELETE/v11_1/vlanpoolings

Use this API command to bulk delete VLAN pooling.

Request
HideShow
Body
{
  "idList": [
    "d18e44e0-8af5-11e4-8155-000c299b4765",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Bridge

Retrieve List

GET/v11_1/profiles/bridge

Use this API command to retrieve a list of Bridge profile.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "267ef3a0-738b-11e4-96d5-0a7820524153",
      "name": "new name"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for profile",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the profile",
            "type": "string"
          },
          "name": {
            "description": "Name of the profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          }
        }
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Retrieve

GET/v11_1/profiles/bridge/{id}

Use this API command to retrieve Bridge profile by ID.

Response  200
HideShow
Body
{
  "id": "profileUUID",
  "name": "Bridge profile name",
  "description": "Bridge profile description",
  "dhcpRelay": {
    "dhcpRelayEnabled": true,
    "dhcpServer1": "172.13.22.5",
    "dhcpServer2": "172.13.22.10",
    "relayBothEnabled": false,
    "dhcpOption82": {
      "dhcpOption82Enabled": true,
      "subopt1Enabled": true,
      "subopt1Format": "AP_MAC_hex_ESSID",
      "subopt2Enabled": true,
      "subopt2Format": "AP_MAC_hex",
      "subopt150Enabled": false,
      "subopt151Enabled": true,
      "subopt151Format": "AREA_NAME",
      "subopt151AreaName": "testAreaName"
    }
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile Id",
      "type": "string"
    },
    "name": {
      "description": "Name of Bridge profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Bridge profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "dhcpRelay": {
      "description": "DHCP Relay",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "dhcpRelayEnabled": {
          "description": "Enable DHCP Relay",
          "type": "boolean"
        },
        "dhcpServer1": {
          "description": "DHCP Server 1",
          "type": "string"
        },
        "dhcpServer2": {
          "description": "DHCP Server 2",
          "type": "string"
        },
        "relayBothEnabled": {
          "description": "Send DHCP requests to both servers simultaneously.",
          "type": "boolean"
        },
        "dhcpOption82": {
          "description": "DHCP Option 82",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "dhcpOption82Enabled": {
              "description": "Enable DHCP Option 82",
              "type": "boolean"
            },
            "subopt1Enabled": {
              "description": "Enable subopt-1",
              "type": "boolean"
            },
            "subopt1Format": {
              "description": "Subopt-1 format",
              "type": "string",
              "enum": [
                "AP_INFO",
                "AP_MAC_hex",
                "AP_MAC_hex_ESSID",
                "AP_INFO_LOCATION"
              ]
            },
            "subopt2Enabled": {
              "description": "Enable subopt-2",
              "type": "boolean"
            },
            "subopt2Format": {
              "description": "Subopt-2 format",
              "type": "string",
              "enum": [
                "CLIENT_MAC_hex",
                "CLIENT_MAC_hex_ESSID",
                "AP_MAC_hex",
                "AP_MAC__hex_ESSID"
              ]
            },
            "subopt150Enabled": {
              "description": "Subopt-150 with VLAN",
              "type": "boolean"
            },
            "subopt151Enabled": {
              "description": "Enable subopt-151",
              "type": "boolean"
            },
            "subopt151Format": {
              "description": "Subopt-151 format",
              "type": "string",
              "enum": [
                "AREA_NAME",
                "ESSID"
              ]
            },
            "subopt151AreaName": {
              "description": "Subopt-151 Area Name value",
              "type": "string"
            }
          }
        }
      }
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Query List

POST/v11_1/profiles/bridge/query

Use this API command to query a list of Bridge profile. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "86ab95e0-dd46-11e6-bfbb-64006a6a50c6",
      "name": "Factory Default",
      "description": "The default bridge forwarding profile",
      "dhcpRelay": {
        "dhcpRelayEnabled": false,
        "dhcpServer1": null,
        "dhcpServer2": null,
        "relayBothEnabled": null,
        "dhcpOption82": null
      },
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "createDateTime": 1484720565821,
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "admin",
      "modifiedDateTime": 1484720565822,
      "creatorUsername": "admin",
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    }
  ],
  "extra": {}
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Profile Id",
            "type": "string"
          },
          "name": {
            "description": "Name of Bridge profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the Bridge profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "dhcpRelay": {
            "description": "DHCP Relay",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "dhcpRelayEnabled": {
                "description": "Enable DHCP Relay",
                "type": "boolean"
              },
              "dhcpServer1": {
                "description": "DHCP Server 1",
                "type": "string"
              },
              "dhcpServer2": {
                "description": "DHCP Server 2",
                "type": "string"
              },
              "relayBothEnabled": {
                "description": "Send DHCP requests to both servers simultaneously.",
                "type": "boolean"
              },
              "dhcpOption82": {
                "description": "DHCP Option 82",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "dhcpOption82Enabled": {
                    "description": "Enable DHCP Option 82",
                    "type": "boolean"
                  },
                  "subopt1Enabled": {
                    "description": "Enable subopt-1",
                    "type": "boolean"
                  },
                  "subopt1Format": {
                    "description": "Subopt-1 format",
                    "type": "string",
                    "enum": [
                      "AP_INFO",
                      "AP_MAC_hex",
                      "AP_MAC_hex_ESSID",
                      "AP_INFO_LOCATION"
                    ]
                  },
                  "subopt2Enabled": {
                    "description": "Enable subopt-2",
                    "type": "boolean"
                  },
                  "subopt2Format": {
                    "description": "Subopt-2 format",
                    "type": "string",
                    "enum": [
                      "CLIENT_MAC_hex",
                      "CLIENT_MAC_hex_ESSID",
                      "AP_MAC_hex",
                      "AP_MAC__hex_ESSID"
                    ]
                  },
                  "subopt150Enabled": {
                    "description": "Subopt-150 with VLAN",
                    "type": "boolean"
                  },
                  "subopt151Enabled": {
                    "description": "Enable subopt-151",
                    "type": "boolean"
                  },
                  "subopt151Format": {
                    "description": "Subopt-151 format",
                    "type": "string",
                    "enum": [
                      "AREA_NAME",
                      "ESSID"
                    ]
                  },
                  "subopt151AreaName": {
                    "description": "Subopt-151 Area Name value",
                    "type": "string"
                  }
                }
              }
            }
          },
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    }
  }
}

AP Registration Rules

move priority up

GET/v11_1/apRules/priorityUp/{id}

Use this API command to move Priority Up of AP Registration Rules profile.

Response  204

Retrieve List

GET/v11_1/apRules

Use this API command to retrieve a list of AP Registration Rules profile.

Response  200
HideShow
Body
{
  "totalCount": 3,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "f031d790-f2dd-11e4-b4f9-000c292547b9",
      "priority": 1,
      "description": "aprule1"
    },
    {
      "id": "ba7b3fb0-f2fb-11e4-b680-80fa5b024259",
      "priority": 2,
      "description": "aprule2"
    },
    {
      "id": "ba7b3fb0-f2fb-11e4-b680-80fa5b024259",
      "priority": 3,
      "description": "aprule3"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the AP Registration Rules",
            "type": "string"
          },
          "priority": {
            "description": "priority of the AP Registration Rules",
            "type": "integer"
          },
          "description": {
            "description": "Description of the AP Registration Rules",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          }
        }
      }
    }
  }
}

move priority down

GET/v11_1/apRules/priorityDown/{id}

Use this API command to move Priority Down of AP Registration Rules profile.

Response  204

Retrieve

GET/v11_1/apRules/{id}

Use this API command to retrieve AP Registration Rules profile by ID.

Response  200
HideShow
Body
{
  "id": "f031d790-f2dd-11e4-b4f9-000c292547b9",
  "priority": 1,
  "description": "aprule1",
  "type": "IPAddressRange",
  "ipAddressRange": {
    "fromIp": "11.11.11.17",
    "toIp": "11.11.11.18"
  },
  "subnet": null,
  "gpsCoordinates": null,
  "provisionTag": null,
  "mobilityZone": {
    "id": "1690614e-1c1f-4fe8-9144-24ccf28d83c4",
    "name": "api-test-zone"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the AP Registration Rules",
      "type": "string"
    },
    "priority": {
      "description": "priority of the AP Registration Rules",
      "type": "integer"
    },
    "description": {
      "description": "Description of the AP Registration Rules",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "type": {
      "description": "type of the AP Registration Rules",
      "type": "string",
      "enum": [
        "IPAddressRange",
        "Subnet",
        "GPSCoordinates",
        "ProvisionTag"
      ]
    },
    "ipAddressRange": {
      "description": "IPAddressRange of the AP Registration Rules",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "fromIp": {
          "description": "from IP Address",
          "type": "string"
        },
        "toIp": {
          "description": "to IP Address",
          "type": "string"
        }
      }
    },
    "subnet": {
      "description": "Subnet of the AP Registration Rules",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "networkAddress": {
          "description": "networkAddress",
          "type": "string"
        },
        "subnetMask": {
          "description": "subnetMask",
          "type": "string"
        }
      }
    },
    "gpsCoordinates": {
      "description": "GPSCoordinates of the AP Registration Rules",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "latitude": {
          "description": "latitude",
          "type": "number"
        },
        "longitude": {
          "description": "longitude",
          "type": "number"
        },
        "distance": {
          "description": "distance",
          "type": "number"
        }
      }
    },
    "provisionTag": {
      "description": "ProvisionTag of the AP Registration Rules",
      "pattern": "^[!-~]([!-~]){0,31}$"
    },
    "mobilityZone": {
      "description": "mobilityZone of the AP Registration Rules",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}

Create

POST/v11_1/apRules

Use this API command to create AP Registration Rules profile.

Request
HideShow
Body
{
  "description": "postman_aprule",
  "type": "IPAddressRange",
  "ipAddressRange": {
    "fromIp": "11.11.11.11",
    "toIp": "11.11.11.13"
  },
  "mobilityZone": {
    "id": "1690614e-1c1f-4fe8-9144-24ccf28d83c4"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "description": {
      "description": "Description of the AP Registration Rules",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "type": {
      "description": "type of the AP Registration Rules",
      "type": "string",
      "enum": [
        "IPAddressRange",
        "Subnet",
        "GPSCoordinates",
        "ProvisionTag"
      ]
    },
    "ipAddressRange": {
      "description": "IPAddressRange of the AP Registration Rules",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "fromIp": {
          "description": "from IP Address",
          "type": "string"
        },
        "toIp": {
          "description": "to IP Address",
          "type": "string"
        }
      }
    },
    "subnet": {
      "description": "Subnet of the AP Registration Rules",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "networkAddress": {
          "description": "networkAddress",
          "type": "string"
        },
        "subnetMask": {
          "description": "subnetMask",
          "type": "string"
        }
      }
    },
    "gpsCoordinates": {
      "description": "GPSCoordinates of the AP Registration Rules",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "latitude": {
          "description": "latitude",
          "type": "number"
        },
        "longitude": {
          "description": "longitude",
          "type": "number"
        },
        "distance": {
          "description": "distance",
          "type": "number"
        }
      }
    },
    "provisionTag": {
      "description": "ProvisionTag of the AP Registration Rules",
      "pattern": "^[!-~]([!-~]){0,31}$"
    },
    "mobilityZone": {
      "description": "mobilityZone of the AP Registration Rules",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "type",
    "mobilityZone"
  ]
}
Response  201
HideShow
Body
{
  "id": "f031d790-f2dd-11e4-b4f9-000c292547b9"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v11_1/apRules/{id}

Use this API command to modify the configuration of AP Registration Rules profile.

Request
HideShow
Body
{
  "description": "postman_aprule",
  "type": "Subnet",
  "provisionTag": "provisiontag",
  "ipAddressRange": {
    "fromIp": "11.11.11.11",
    "toIp": "11.11.11.13"
  },
  "subnet": {
    "networkAddress": "11.11.11.11",
    "subnetMask": "255.255.0.0"
  },
  "gpsCoordinates": {
    "latitude": 50.11,
    "longitude": 100.533,
    "distance": 10
  },
  "mobilityZone": {
    "id": "1690614e-1c1f-4fe8-9144-24ccf28d83c4"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "description": {
      "description": "Description of the AP Registration Rules",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "type": {
      "description": "type of the AP Registration Rules",
      "type": "string",
      "enum": [
        "IPAddressRange",
        "Subnet",
        "GPSCoordinates",
        "ProvisionTag"
      ]
    },
    "provisionTag": {
      "description": "ProvisionTag of the AP Registration Rules",
      "type": "string",
      "pattern": "^[!-~]([!-~]){0,31}$"
    },
    "mobilityZone": {
      "description": "mobilityZone of the AP Registration Rules",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ipAddressRange": {
      "description": "IPAddressRange of the AP Registration Rules",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "fromIp": {
          "description": "from IP Address",
          "type": "string"
        },
        "toIp": {
          "description": "to IP Address",
          "type": "string"
        }
      }
    },
    "subnet": {
      "description": "Subnet of the AP Registration Rules",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "networkAddress": {
          "description": "networkAddress",
          "type": "string"
        },
        "subnetMask": {
          "description": "subnetMask",
          "type": "string"
        }
      }
    },
    "gpsCoordinates": {
      "description": "GPSCoordinates of the AP Registration Rules",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "latitude": {
          "description": "latitude",
          "type": "number"
        },
        "longitude": {
          "description": "longitude",
          "type": "number"
        },
        "distance": {
          "description": "distance",
          "type": "number"
        }
      }
    }
  }
}
Response  204

Delete

DELETE/v11_1/apRules/{id}

Use this API command to delete AP Registration Rules profile.

Response  204

RuckusGRE Tunnel Profile

Retrieve

GET/v11_1/profiles/tunnel/ruckusgre/{id}

Use this API command to retrieve RuckusGRE tunnel profile.

Response  200
HideShow
Body
{
  "name": "RuckusGRE tunnel profile name",
  "description": "RuckusGRE tunnel profile description",
  "tunnelMode": "GRE",
  "tunnelEncryption": "AES256",
  "tunnelMtuAutoEnabled": "MANUAL",
  "tunnelMtuSize": 1500,
  "keepAlivePeriod": 10,
  "keepAliveRetry": 6,
  "dualTunnel": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile Id",
      "type": "string"
    },
    "name": {
      "description": "name of the RuckusGRE profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the RuckusGRE profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "tunnelMode": {
      "description": "Ruckus Tunnel Mode of RuckusGRE profile",
      "type": "string",
      "enum": [
        "GRE",
        "GREUDP"
      ]
    },
    "tunnelEncryption": {
      "description": "Tunnel Encryption of the RuckusGRE profile",
      "type": "string",
      "enum": [
        "DISABLE",
        "AES128",
        "AES256"
      ]
    },
    "tunnelMtuAutoEnabled": {
      "description": "WAN Interface MTU of the RuckusGRE profile",
      "type": "string",
      "enum": [
        "AUTO",
        "MANUAL"
      ]
    },
    "tunnelMtuSize": {
      "description": "Tunnel MTU size of RuckusGRE profile",
      "type": "integer"
    },
    "keepAlivePeriod": {
      "description": "Dual Tunnel Keep-Alive Period",
      "type": "integer",
      "minimum": 1,
      "maximum": 255,
      "default": 10
    },
    "keepAliveRetry": {
      "description": "Dual Tunnel Keep-Alive Retry",
      "type": "integer",
      "minimum": 0,
      "maximum": 20,
      "default": 6
    },
    "dualTunnel": {
      "description": "Dual Tunnel",
      "type": "boolean"
    },
    "domainId": {
      "description": "Domain id of the RuckusGRE profile",
      "type": "string"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Retrieve List

GET/v11_1/profiles/tunnel/ruckusgre

Use this API command to retrieve a list of RuckusGRE tunnel profile.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "267ef3a0-738b-11e4-96d5-0a7820524153",
      "name": "new name"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for profile",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the profile",
            "type": "string"
          },
          "name": {
            "description": "Name of the profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          }
        }
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Create

POST/v11_1/profiles/tunnel/ruckusgre

Use this API command to create RuckusGRE tunnel profile.

Request
HideShow
Body
{
  "name": "RuckusGRE tunnel profile name",
  "description": "RuckusGRE tunnel profile description",
  "tunnelMode": "GREUDP",
  "tunnelEncryption": "AES128",
  "tunnelMtuAutoEnabled": "AUTO",
  "keepAlivePeriod": 10,
  "keepAliveRetry": 6,
  "dualTunnel": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile Id",
      "type": "string"
    },
    "name": {
      "description": "name of the RuckusGRE profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the RuckusGRE profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "tunnelMode": {
      "description": "Ruckus Tunnel Mode of RuckusGRE profile",
      "type": "string",
      "enum": [
        "GRE",
        "GREUDP"
      ]
    },
    "tunnelEncryption": {
      "description": "Tunnel Encryption of the RuckusGRE profile",
      "type": "string",
      "enum": [
        "DISABLE",
        "AES128",
        "AES256"
      ]
    },
    "tunnelMtuAutoEnabled": {
      "description": "WAN Interface MTU of the RuckusGRE profile",
      "type": "string",
      "enum": [
        "AUTO",
        "MANUAL"
      ]
    },
    "tunnelMtuSize": {
      "description": "Tunnel MTU size of RuckusGRE profile",
      "type": "integer",
      "minimum": 850,
      "maximum": 9018,
      "default": 1500
    },
    "keepAlivePeriod": {
      "description": "Tunnel Failover Keep-Alive Period",
      "type": "integer",
      "minimum": 1,
      "maximum": 255,
      "default": 10
    },
    "keepAliveRetry": {
      "description": "Tunnel Failover Keep-Alive Retry",
      "type": "integer",
      "minimum": 0,
      "maximum": 20,
      "default": 6
    },
    "dualTunnel": {
      "description": "Tunnel Failover",
      "type": "boolean"
    },
    "domainId": {
      "description": "Domain id of the RuckusGRE profile",
      "type": "string"
    }
  },
  "required": [
    "name",
    "tunnelMtuAutoEnabled"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Query List

POST/v11_1/profiles/tunnel/ruckusgre/query

Use this API command to query a list of RuckusGRE tunnel profile. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "name": "RuckusGRE tunnel profile name",
      "description": "RuckusGRE tunnel profile description",
      "tunnelMode": "GRE",
      "tunnelEncryption": "AES128",
      "tunnelMtuAutoEnabled": "MANUAL",
      "tunnelMtuSize": 1500
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Profile Id",
            "type": "string"
          },
          "name": {
            "description": "name of the RuckusGRE profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "description of the RuckusGRE profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "tunnelMode": {
            "description": "Ruckus Tunnel Mode of RuckusGRE profile",
            "type": "string",
            "enum": [
              "GRE",
              "GREUDP"
            ]
          },
          "tunnelEncryption": {
            "description": "Tunnel Encryption of the RuckusGRE profile",
            "type": "string",
            "enum": [
              "DISABLE",
              "AES128",
              "AES256"
            ]
          },
          "tunnelMtuAutoEnabled": {
            "description": "WAN Interface MTU of the RuckusGRE profile",
            "type": "string",
            "enum": [
              "AUTO",
              "MANUAL"
            ]
          },
          "tunnelMtuSize": {
            "description": "Tunnel MTU size of RuckusGRE profile",
            "type": "integer"
          },
          "keepAlivePeriod": {
            "description": "Dual Tunnel Keep-Alive Period",
            "type": "integer",
            "minimum": 1,
            "maximum": 255,
            "default": 10
          },
          "keepAliveRetry": {
            "description": "Dual Tunnel Keep-Alive Retry",
            "type": "integer",
            "minimum": 0,
            "maximum": 20,
            "default": 6
          },
          "dualTunnel": {
            "description": "Dual Tunnel",
            "type": "boolean"
          },
          "domainId": {
            "description": "Domain id of the RuckusGRE profile",
            "type": "string"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    }
  }
}

Modify

PATCH/v11_1/profiles/tunnel/ruckusgre/{id}

Use this API command to modify the configuration of RuckusGRE tunnel profile.

Request
HideShow
Body
{
  "name": "RuckusGRE tunnel profile name",
  "description": "RuckusGRE tunnel profile description",
  "tunnelMode": "GRE",
  "tunnelEncryption": "DISABLE",
  "tunnelMtuAutoEnabled": "MANUAL",
  "tunnelMtuSize": 1500,
  "keepAlivePeriod": 10,
  "keepAliveRetry": 6,
  "dualTunnel": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile Id",
      "type": "string"
    },
    "name": {
      "description": "name of the RuckusGRE profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the RuckusGRE profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "tunnelMode": {
      "description": "Ruckus Tunnel Mode of RuckusGRE profile",
      "type": "string",
      "enum": [
        "GRE",
        "GREUDP"
      ]
    },
    "tunnelEncryption": {
      "description": "Tunnel Encryption of the RuckusGRE profile",
      "type": "string",
      "enum": [
        "DISABLE",
        "AES128",
        "AES256"
      ]
    },
    "tunnelMtuAutoEnabled": {
      "description": "WAN Interface MTU of the RuckusGRE profile",
      "type": "string",
      "enum": [
        "AUTO",
        "MANUAL"
      ]
    },
    "tunnelMtuSize": {
      "description": "Tunnel MTU size of RuckusGRE profile",
      "type": "integer",
      "minimum": 850,
      "maximum": 9018
    },
    "keepAlivePeriod": {
      "description": "Dual Tunnel Keep-Alive Period",
      "type": "integer",
      "minimum": 1,
      "maximum": 255
    },
    "keepAliveRetry": {
      "description": "Dual Tunnel Keep-Alive Retry",
      "type": "integer",
      "minimum": 0,
      "maximum": 20
    },
    "dualTunnel": {
      "description": "Dual Tunnel ",
      "type": "boolean"
    },
    "domainId": {
      "description": "Domain id of the RuckusGRE profile",
      "type": "string"
    }
  }
}
Response  204

Delete

DELETE/v11_1/profiles/tunnel/ruckusgre/{id}

Use this API command to delete RuckusGRE tunnel profile.

Response  204

Delete

DELETE/v11_1/profiles/tunnel/ruckusgre

Use this API command to delete multiple RuckusGRE tunnel profile.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

SoftGRE Tunnel Profile

Retrieve

GET/v11_1/profiles/tunnel/softgre/{id}

Use this API command to retrieve SoftGRE tunnel profile.

Response  200
HideShow
Body
{
  "name": "SoftGRE tunnel profile name",
  "description": "SoftGRE tunnel profile description",
  "ipMode": "IPV6",
  "primaryGateway": "2222:3333::5555",
  "secondaryGateway": "2222:3333::1111",
  "tunnelMtuAutoEnabled": "MANUAL",
  "tunnelMtuSize": 1500,
  "keepAlivePeriod": 10,
  "keepAliveRetry": 5,
  "forceDisassociateClient": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile Id",
      "type": "string"
    },
    "name": {
      "description": "name of the SoftGRE profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the SoftGRE profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "ipMode": {
      "description": "Gateway IP Mode of SoftGRE profile",
      "type": "string",
      "enum": [
        "IPV4",
        "IPV6"
      ]
    },
    "primaryGateway": {
      "description": "Primary gateway address of the SoftGRE profile",
      "type": "string"
    },
    "secondaryGateway": {
      "description": "Secondary gateway address of the SoftGRE profile",
      "type": "string"
    },
    "tunnelMtuAutoEnabled": {
      "description": "WAN Interface MTU of the SoftGRE profile",
      "type": "string",
      "enum": [
        "AUTO",
        "MANUAL"
      ]
    },
    "tunnelMtuSize": {
      "description": "Tunnel MTU size of SoftGRE profile",
      "type": "integer"
    },
    "keepAlivePeriod": {
      "description": "ICMP Keep-Alive Period(secs)",
      "type": "integer"
    },
    "keepAliveRetry": {
      "description": "ICMP Keep-Alive Retry",
      "type": "integer"
    },
    "forceDisassociateClient": {
      "description": "Force Disassociate Client",
      "type": "boolean"
    },
    "domainId": {
      "description": "Domain id of the SoftGRE profile",
      "type": "string"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Retrieve List

GET/v11_1/profiles/tunnel/softgre

Use this API command to retrieve a list of SoftGRE tunnel profile.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "267ef3a0-738b-11e4-96d5-0a7820524153",
      "name": "new name"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for profile",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the profile",
            "type": "string"
          },
          "name": {
            "description": "Name of the profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          }
        }
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Create

POST/v11_1/profiles/tunnel/softgre

Use this API command to create SoftGRE tunnel profile.

Request
HideShow
Body
{
  "name": "SoftGRE tunnel profile name",
  "description": "SoftGRE tunnel profile description",
  "ipMode": "IPV4",
  "primaryGateway": "172.18.110.29",
  "secondaryGateway": "192.168.10.1",
  "tunnelMtuAutoEnabled": "MANUAL",
  "tunnelMtuSize": 1500,
  "keepAlivePeriod": 10,
  "keepAliveRetry": 5,
  "forceDisassociateClient": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile Id",
      "type": "string"
    },
    "name": {
      "description": "name of the SoftGRE profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the SoftGRE profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "ipMode": {
      "description": "Gateway IP Mode of SoftGRE profile",
      "type": "string",
      "enum": [
        "IPV4",
        "IPV6"
      ]
    },
    "primaryGateway": {
      "description": "Primary gateway address of the SoftGRE profile",
      "type": "string"
    },
    "secondaryGateway": {
      "description": "Secondary gateway address of the SoftGRE profile",
      "type": "string"
    },
    "tunnelMtuAutoEnabled": {
      "description": "WAN Interface MTU of the SoftGRE profile",
      "type": "string",
      "enum": [
        "AUTO",
        "MANUAL"
      ]
    },
    "tunnelMtuSize": {
      "description": "Tunnel MTU size of SoftGRE profile. IPV4:850-1500, IPV6:1384-1500. Default 1500.",
      "type": "integer",
      "minimum": 850,
      "maximum": 9018,
      "default": 1500
    },
    "keepAlivePeriod": {
      "description": "ICMP Keep-Alive Period(secs)",
      "type": "integer",
      "minimum": 1,
      "maximum": 180
    },
    "keepAliveRetry": {
      "description": "ICMP Keep-Alive Retry",
      "type": "integer",
      "minimum": 2,
      "maximum": 20
    },
    "forceDisassociateClient": {
      "description": "Force Disassociate Client",
      "type": "boolean"
    },
    "domainId": {
      "description": "Domain id of the SoftGRE profile",
      "type": "string"
    }
  },
  "required": [
    "name",
    "primaryGateway",
    "tunnelMtuAutoEnabled",
    "keepAlivePeriod",
    "keepAliveRetry"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Query List

POST/v11_1/profiles/tunnel/softgre/query

Use this API command to query a list of SoftGRE tunnel profile. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "name": "SoftGRE tunnel profile name",
      "description": "SoftGRE tunnel profile description",
      "ipMode": "IPV6",
      "primaryGateway": "2222:3333::5555",
      "secondaryGateway": "2222:3333::1111",
      "tunnelMtuAutoEnabled": "MANUAL",
      "tunnelMtuSize": 1500,
      "keepAlivePeriod": 10,
      "keepAliveRetry": 5,
      "forceDisassociateClient": false
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Profile Id",
            "type": "string"
          },
          "name": {
            "description": "name of the SoftGRE profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "description of the SoftGRE profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "ipMode": {
            "description": "Gateway IP Mode of SoftGRE profile",
            "type": "string",
            "enum": [
              "IPV4",
              "IPV6"
            ]
          },
          "primaryGateway": {
            "description": "Primary gateway address of the SoftGRE profile",
            "type": "string"
          },
          "secondaryGateway": {
            "description": "Secondary gateway address of the SoftGRE profile",
            "type": "string"
          },
          "tunnelMtuAutoEnabled": {
            "description": "WAN Interface MTU of the SoftGRE profile",
            "type": "string",
            "enum": [
              "AUTO",
              "MANUAL"
            ]
          },
          "tunnelMtuSize": {
            "description": "Tunnel MTU size of SoftGRE profile",
            "type": "integer"
          },
          "keepAlivePeriod": {
            "description": "ICMP Keep-Alive Period(secs)",
            "type": "integer"
          },
          "keepAliveRetry": {
            "description": "ICMP Keep-Alive Retry",
            "type": "integer"
          },
          "forceDisassociateClient": {
            "description": "Force Disassociate Client",
            "type": "boolean"
          },
          "domainId": {
            "description": "Domain id of the SoftGRE profile",
            "type": "string"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    }
  }
}

Modify

PATCH/v11_1/profiles/tunnel/softgre/{id}

Use this API command to modify the configuration of SoftGRE tunnel profile.

Request
HideShow
Body
{
  "name": "SoftGRE tunnel profile name",
  "description": "SoftGRE tunnel profile description",
  "primaryGateway": "172.18.110.50",
  "secondaryGateway": "192.168.10.2",
  "tunnelMtuAutoEnabled": "AUTO",
  "keepAlivePeriod": 10,
  "keepAliveRetry": 5,
  "forceDisassociateClient": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile Id",
      "type": "string"
    },
    "name": {
      "description": "name of the SoftGRE profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the SoftGRE profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "primaryGateway": {
      "description": "Primary gateway address of the SoftGRE profile",
      "type": "string"
    },
    "secondaryGateway": {
      "description": "Secondary gateway address of the SoftGRE profile",
      "type": "string"
    },
    "tunnelMtuAutoEnabled": {
      "description": "WAN Interface MTU of the SoftGRE profile",
      "type": "string",
      "enum": [
        "AUTO",
        "MANUAL"
      ]
    },
    "tunnelMtuSize": {
      "description": "Tunnel MTU size of SoftGRE profile. IPV4:850-1500, IPV6:1384-1500. Default 1500.",
      "type": "integer",
      "minimum": 850,
      "maximum": 9018
    },
    "keepAlivePeriod": {
      "description": "ICMP Keep-Alive Period(secs)",
      "type": "integer",
      "minimum": 1,
      "maximum": 180
    },
    "keepAliveRetry": {
      "description": "ICMP Keep-Alive Retry",
      "type": "integer",
      "minimum": 2,
      "maximum": 20
    },
    "forceDisassociateClient": {
      "description": "Force Disassociate Client",
      "type": "boolean"
    },
    "domainId": {
      "description": "Domain id of the SoftGRE profile",
      "type": "string"
    }
  }
}
Response  204

Delete

DELETE/v11_1/profiles/tunnel/softgre/{id}

Use this API command to delete SoftGRE tunnel profile.

Response  204

Delete

DELETE/v11_1/profiles/tunnel/softgre

Use this API command to delete multiple SoftGRE tunnel profile.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

LBS profile

Create LBS profile

GET/v11_1/profiles/lbs/{id}

Retrieve LBS profile.

Response  200
HideShow
Body
{
  "venue": "Venue name",
  "url": "172.17.60.79",
  "port": 8883,
  "password": "pwd$321"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile Id",
      "type": "string"
    },
    "name": {
      "description": "LBS name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "LBS description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "url": {
      "description": "LBS url",
      "type": "string"
    },
    "port": {
      "description": "LBS port",
      "type": "integer"
    },
    "password": {
      "description": "Password",
      "type": "string"
    },
    "venue": {
      "description": "Venue",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "tlsVersion": {
      "type": "string"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Query LBS profiles

POST/v11_1/profiles/lbs/query

Query LBS profiles. Please click the link for the usage of Query Criteria.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "DOMAIN",
              "ZONE",
              "PROFILEID"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "createDateTime": 1484720657214,
      "modifiedDateTime": 1484720657215,
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "creatorUsername": "Admin",
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "Admin",
      "name": "Venue1",
      "url": "lbs.ruckuswireless.com",
      "port": 50,
      "password": null,
      "venue": "Venue1",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "id": "bd24e5e1-dd46-11e6-bfbb-64006a6a50c6"
    },
    {
      "createDateTime": 1484720657237,
      "modifiedDateTime": 1484720657237,
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "creatorUsername": "Admin",
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "Admin",
      "name": "Venue2",
      "url": "lbs.ruckuswireless.com",
      "port": 50,
      "password": null,
      "venue": "Venue2",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "id": "bd286851-dd46-11e6-bfbb-64006a6a50c6"
    }
  ],
  "extra": {}
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Profile Id",
            "type": "string"
          },
          "name": {
            "description": "LBS name",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "LBS description",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "url": {
            "description": "LBS url",
            "type": "string"
          },
          "port": {
            "description": "LBS port",
            "type": "integer"
          },
          "password": {
            "description": "Password",
            "type": "string"
          },
          "venue": {
            "description": "Venue",
            "type": "string"
          },
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "tlsVersion": {
            "type": "string"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    }
  }
}

Create LBS profile

POST/v11_1/profiles/lbs

Create LBS profile.

Request
HideShow
Body
{
  "venue": "Venue name",
  "url": "172.17.60.79",
  "port": 8883,
  "password": "pwd$321"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile Id",
      "type": "string"
    },
    "name": {
      "description": "LBS name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "LBS description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "url": {
      "description": "LBS url",
      "type": "string"
    },
    "port": {
      "description": "LBS port",
      "type": "integer"
    },
    "password": {
      "description": "Password",
      "type": "string"
    },
    "venue": {
      "description": "Venue",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "tlsVersion": {
      "type": "string"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Update LBS profile

PATCH/v11_1/profiles/lbs/{id}

Update LBS profile.

Request
HideShow
Body
{
  "venue": "Venue name",
  "url": "172.17.60.79",
  "port": 8883,
  "password": "pwd$321"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile Id",
      "type": "string"
    },
    "name": {
      "description": "LBS name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "LBS description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "url": {
      "description": "LBS url",
      "type": "string"
    },
    "port": {
      "description": "LBS port",
      "type": "integer"
    },
    "password": {
      "description": "Password",
      "type": "string"
    },
    "venue": {
      "description": "Venue",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "tlsVersion": {
      "type": "string"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}
Response  200

Delete LBS profile

DELETE/v11_1/profiles/lbs/{id}

Delete LBS profile.

Response  200

Delete multiple LBS profile

DELETE/v11_1/profiles/lbs

Delete multiple LBS profile.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200

Precedence Profile

Get Precedence Profile list

GET/v11_1/precedence

Use this API command to Get Precedence Profile list.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "be52f970-e9da-11e6-952e-64006a6a50c6",
      "name": "precedence",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "vlanPrecedence": [
        {
          "priority": 1,
          "name": "AAA"
        },
        {
          "priority": 2,
          "name": "DEVICE"
        },
        {
          "priority": 3,
          "name": "WLAN"
        }
      ],
      "rateLimitingPrecedence": [
        {
          "priority": 1,
          "name": "AAA"
        },
        {
          "priority": 2,
          "name": "DEVICE"
        },
        {
          "priority": 3,
          "name": "WLANUTP"
        }
      ]
    }
  ],
  "extra": {}
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for profile",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the profile",
            "type": "string"
          },
          "name": {
            "description": "Name of the profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "domainId": {
            "description": "Domain UUID",
            "type": "string"
          },
          "vlanPrecedence": {
            "type": "array",
            "description": "vlan precedence",
            "items": {
              "type": "object",
              "description": "Vlan precedence item",
              "additionalProperties": false,
              "properties": {
                "priority": {
                  "type": "integer",
                  "description": "Priority"
                },
                "name": {
                  "type": "string",
                  "enum": [
                    "AAA",
                    "DEVICE",
                    "WLAN"
                  ],
                  "description": "Name of the Vlan precedence item"
                }
              }
            }
          },
          "rateLimitingPrecedence": {
            "type": "array",
            "description": "rate limiting precedence",
            "items": {
              "type": "object",
              "description": "Rate limiting precedence item",
              "additionalProperties": false,
              "properties": {
                "priority": {
                  "type": "integer",
                  "description": "Priority"
                },
                "name": {
                  "type": "string",
                  "enum": [
                    "AAA",
                    "DEVICE",
                    "WLANUTP"
                  ],
                  "description": "Name of rate limiting precedence item"
                }
              }
            }
          }
        }
      }
    }
  }
}

Get Precedence Profile by profile's ID

GET/v11_1/precedence/{id}

Use this API command to Get Precedence Profile by profile’s ID.

Response  200
HideShow
Body
{
  "name": "precedence-name01",
  "domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
  "vlanPrecedence": [
    {
      "priority": 1,
      "name": "AAA"
    },
    {
      "priority": 2,
      "name": "DEVICE"
    },
    {
      "priority": 3,
      "name": "WLAN"
    }
  ],
  "rateLimitingPrecedence": [
    {
      "priority": 1,
      "name": "AAA"
    },
    {
      "priority": 2,
      "name": "DEVICE"
    },
    {
      "priority": 3,
      "name": "WLANUTP"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the precedence profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "domainId": {
      "description": "Domain UUID",
      "type": "string"
    },
    "vlanPrecedence": {
      "type": "array",
      "description": "vlan precedence",
      "items": {
        "type": "object",
        "description": "Vlan precedence item",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "type": "integer",
            "description": "Priority"
          },
          "name": {
            "type": "string",
            "enum": [
              "AAA",
              "DEVICE",
              "WLAN"
            ],
            "description": "Name of the Vlan precedence item"
          }
        }
      }
    },
    "rateLimitingPrecedence": {
      "type": "array",
      "description": "rate limiting precedence",
      "items": {
        "type": "object",
        "description": "Rate limiting precedence item",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "type": "integer",
            "description": "Priority"
          },
          "name": {
            "type": "string",
            "enum": [
              "AAA",
              "DEVICE",
              "WLANUTP"
            ],
            "description": "Name of rate limiting precedence item"
          }
        }
      }
    }
  }
}

Query Precedence Profile

POST/v11_1/precedence/query

Use this API command to query Precedence Profile. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "be52f970-e9da-11e6-952e-64006a6a50c6",
      "name": "precedence",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "vlanPrecedence": [
        {
          "priority": 1,
          "name": "AAA"
        },
        {
          "priority": 2,
          "name": "DEVICE"
        },
        {
          "priority": 3,
          "name": "WLAN"
        }
      ],
      "rateLimitingPrecedence": [
        {
          "priority": 1,
          "name": "AAA"
        },
        {
          "priority": 2,
          "name": "DEVICE"
        },
        {
          "priority": 3,
          "name": "WLANUTP"
        }
      ]
    }
  ],
  "extra": {}
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for profile",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the profile",
            "type": "string"
          },
          "name": {
            "description": "Name of the profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "domainId": {
            "description": "Domain UUID",
            "type": "string"
          },
          "vlanPrecedence": {
            "type": "array",
            "description": "vlan precedence",
            "items": {
              "type": "object",
              "description": "Vlan precedence item",
              "additionalProperties": false,
              "properties": {
                "priority": {
                  "type": "integer",
                  "description": "Priority"
                },
                "name": {
                  "type": "string",
                  "enum": [
                    "AAA",
                    "DEVICE",
                    "WLAN"
                  ],
                  "description": "Name of the Vlan precedence item"
                }
              }
            }
          },
          "rateLimitingPrecedence": {
            "type": "array",
            "description": "rate limiting precedence",
            "items": {
              "type": "object",
              "description": "Rate limiting precedence item",
              "additionalProperties": false,
              "properties": {
                "priority": {
                  "type": "integer",
                  "description": "Priority"
                },
                "name": {
                  "type": "string",
                  "enum": [
                    "AAA",
                    "DEVICE",
                    "WLANUTP"
                  ],
                  "description": "Name of rate limiting precedence item"
                }
              }
            }
          }
        }
      }
    }
  }
}

Create Precedence Profile

POST/v11_1/precedence

Use this API command to create Precedence Profile.

Request
HideShow
Body
{
  "name": "precedence-name01",
  "domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
  "vlanPrecedence": [
    {
      "priority": 1,
      "name": "AAA"
    },
    {
      "priority": 2,
      "name": "DEVICE"
    },
    {
      "priority": 3,
      "name": "WLAN"
    }
  ],
  "rateLimitingPrecedence": [
    {
      "priority": 1,
      "name": "AAA"
    },
    {
      "priority": 2,
      "name": "DEVICE"
    },
    {
      "priority": 3,
      "name": "WLANUTP"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the precedence profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "domainId": {
      "description": "Domain UUID",
      "type": "string"
    },
    "vlanPrecedence": {
      "type": "array",
      "description": "vlan precedence",
      "items": {
        "type": "object",
        "description": "Vlan precedence item",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "type": "integer",
            "description": "Priority"
          },
          "name": {
            "type": "string",
            "enum": [
              "AAA",
              "DEVICE",
              "WLAN"
            ],
            "description": "Name of the Vlan precedence item"
          }
        }
      }
    },
    "rateLimitingPrecedence": {
      "type": "array",
      "description": "rate limiting precedence",
      "items": {
        "type": "object",
        "description": "Rate limiting precedence item",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "type": "integer",
            "description": "Priority"
          },
          "name": {
            "type": "string",
            "enum": [
              "AAA",
              "DEVICE",
              "WLANUTP"
            ],
            "description": "Name of rate limiting precedence item"
          }
        }
      }
    }
  }
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Precedence Profile by profile's ID

PATCH/v11_1/precedence/{id}

Use this API command to Modify Precedence Profile by profile’s ID.

Request
HideShow
Body
{
  "name": "precedence-name02",
  "domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
  "vlanPrecedence": [
    {
      "priority": 1,
      "name": "AAA"
    },
    {
      "priority": 2,
      "name": "DEVICE"
    },
    {
      "priority": 3,
      "name": "WLAN"
    }
  ],
  "rateLimitingPrecedence": [
    {
      "priority": 1,
      "name": "AAA"
    },
    {
      "priority": 2,
      "name": "DEVICE"
    },
    {
      "priority": 3,
      "name": "WLANUTP"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the precedence profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "domainId": {
      "description": "Domain UUID",
      "type": "string"
    },
    "vlanPrecedence": {
      "type": "array",
      "description": "vlan precedence",
      "items": {
        "type": "object",
        "description": "Vlan precedence item",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "type": "integer",
            "description": "Priority"
          },
          "name": {
            "type": "string",
            "enum": [
              "AAA",
              "DEVICE",
              "WLAN"
            ],
            "description": "Name of the Vlan precedence item"
          }
        }
      }
    },
    "rateLimitingPrecedence": {
      "type": "array",
      "description": "rate limiting precedence",
      "items": {
        "type": "object",
        "description": "Rate limiting precedence item",
        "additionalProperties": false,
        "properties": {
          "priority": {
            "type": "integer",
            "description": "Priority"
          },
          "name": {
            "type": "string",
            "enum": [
              "AAA",
              "DEVICE",
              "WLANUTP"
            ],
            "description": "Name of rate limiting precedence item"
          }
        }
      }
    }
  }
}
Response  200

Delete Precedence Profile by profile's ID

DELETE/v11_1/precedence/{id}

Use this API command to Delete Precedence Profile by profile’s ID.

Response  204

Bulk Delete Precedence Profile

DELETE/v11_1/precedence

Use this API command to Bulk Delete Precedence Profile.

Request
HideShow
Body
{
  "idList": [
    "d18e44e0-8af5-11e4-8155-000c299b4765",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Portal Detection and Suppression Profile

Get portal detection and suppression profile list

GET/v11_1/rkszones/{zoneId}/portalDetectionProfiles

Use this API command to get portal detection and suppression profile list.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "ef79d5f2-909b-11e8-9f44-000000031906",
      "zoneId": "20e3e3c6-b77c-460f-a886-972b48c49102",
      "name": "My Profile",
      "description": "N/A",
      "portalDetectionPatterns": [
        {
          "name": "Android-Wifi",
          "userAgentPattern": ".*Android.*",
          "httpCode": 200,
          "httpResponseBody": "<HTML><HEAD><TITLE>title</TITLE></HEAD><BODY>It's a default pattern.</BODY></HTML>"
        }
      ],
      "modifierUsername": "admin",
      "modifiedDateTime": 1534231657814,
      "createDateTime": 1534231657812,
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "creatorUsername": "admin"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "Extra information for portal detection and suppression profile",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "zoneId": {
            "description": "Zone ID",
            "type": "string"
          },
          "id": {
            "description": "Identifier of the portal detection and suppression profile",
            "type": "string",
            "maxLength": 64
          },
          "name": {
            "description": "Name of the portal detection and suppression profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the portal detection and suppression profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "portalDetectionPatterns": {
            "description": "The pattern profiles for portal detection and suppression",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "name": {
                  "description": "Name of the portal detection and suppression pattern",
                  "type": "string",
                  "minLength": 2,
                  "maxLength": 32,
                  "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
                },
                "patternType": {
                  "description": "Portal detection and suppression pattern type",
                  "type": "string",
                  "enum": [
                    "USER_AGENT"
                  ]
                },
                "userAgentPattern": {
                  "description": "Portal detection and suppression pattern for user agent",
                  "type": "string",
                  "maxLength": 256
                },
                "httpCode": {
                  "description": "HTTP status codes",
                  "type": "integer",
                  "minimum": 100,
                  "maximum": 599
                },
                "httpResponseBody": {
                  "description": "HTTP response body",
                  "type": "string",
                  "maxLength": 1024
                }
              },
              "required": [
                "name",
                "userAgentPattern",
                "httpCode"
              ]
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier name",
            "type": "string"
          }
        }
      }
    }
  }
}

Get portal detection and suppression profile by profile's ID

GET/v11_1/rkszones/{zoneId}/portalDetectionProfiles/{id}

Use this API command to get portal detection and suppression profile by profile’s ID.

Response  200
HideShow
Body
{
  "id": "74ff0422-93df-11e8-952a-000000031906",
  "zoneId": "20e3e3c6-b77c-460f-a886-972b48c49102",
  "name": "My Profile",
  "description": "N/A",
  "portalDetectionPatterns": [
    {
      "name": "Android-Wifi",
      "patternType": null,
      "userAgentPattern": ".*Android.*",
      "httpCode": 200,
      "httpResponseBody": "<HTML><HEAD><TITLE>title</TITLE></HEAD><BODY>It's a default pattern.</BODY></HTML>"
    }
  ],
  "modifierUsername": "admin",
  "modifiedDateTime": 1534231657814,
  "createDateTime": 1534231657812,
  "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "creatorUsername": "admin"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "zoneId": {
      "description": "Zone ID",
      "type": "string"
    },
    "id": {
      "description": "Identifier of the portal detection and suppression profile",
      "type": "string",
      "maxLength": 64
    },
    "name": {
      "description": "Name of the portal detection and suppression profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the portal detection and suppression profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "portalDetectionPatterns": {
      "description": "The pattern profiles for portal detection and suppression",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "description": "Name of the portal detection and suppression pattern",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "patternType": {
            "description": "Portal detection and suppression pattern type",
            "type": "string",
            "enum": [
              "USER_AGENT"
            ]
          },
          "userAgentPattern": {
            "description": "Portal detection and suppression pattern for user agent",
            "type": "string",
            "maxLength": 256
          },
          "httpCode": {
            "description": "HTTP status codes",
            "type": "integer",
            "minimum": 100,
            "maximum": 599
          },
          "httpResponseBody": {
            "description": "HTTP response body",
            "type": "string",
            "maxLength": 1024
          }
        },
        "required": [
          "name",
          "userAgentPattern",
          "httpCode"
        ]
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier name",
      "type": "string"
    }
  }
}

Retrieve portal detection and suppression profile List

POST/v11_1/rkszones/portalDetectionProfiles/query

Query portal detection and suppression profile with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "ZONE",
      "value": "efe6f380-c769-4038-b144-9b722b80b54a"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "ef79d5f2-909b-11e8-9f44-000000031906",
      "zoneId": "20e3e3c6-b77c-460f-a886-972b48c49102",
      "name": "My Profile",
      "description": "N/A",
      "portalDetectionPatterns": [
        {
          "name": "Android-Wifi",
          "userAgentPattern": ".*Android.*",
          "httpCode": 200,
          "httpResponseBody": "<HTML><HEAD><TITLE>title</TITLE></HEAD><BODY>It's a default pattern.</BODY></HTML>"
        }
      ],
      "modifierUsername": "admin",
      "modifiedDateTime": 1534231657814,
      "createDateTime": 1534231657812,
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "creatorUsername": "admin"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "Extra information for portal detection and suppression profile",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "zoneId": {
            "description": "Zone ID",
            "type": "string"
          },
          "id": {
            "description": "Identifier of the portal detection and suppression profile",
            "type": "string",
            "maxLength": 64
          },
          "name": {
            "description": "Name of the portal detection and suppression profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the portal detection and suppression profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "portalDetectionPatterns": {
            "description": "The pattern profiles for portal detection and suppression",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "name": {
                  "description": "Name of the portal detection and suppression pattern",
                  "type": "string",
                  "minLength": 2,
                  "maxLength": 32,
                  "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
                },
                "patternType": {
                  "description": "Portal detection and suppression pattern type",
                  "type": "string",
                  "enum": [
                    "USER_AGENT"
                  ]
                },
                "userAgentPattern": {
                  "description": "Portal detection and suppression pattern for user agent",
                  "type": "string",
                  "maxLength": 256
                },
                "httpCode": {
                  "description": "HTTP status codes",
                  "type": "integer",
                  "minimum": 100,
                  "maximum": 599
                },
                "httpResponseBody": {
                  "description": "HTTP response body",
                  "type": "string",
                  "maxLength": 1024
                }
              },
              "required": [
                "name",
                "userAgentPattern",
                "httpCode"
              ]
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier name",
            "type": "string"
          }
        }
      }
    }
  }
}

Create portal detection and suppression profile

POST/v11_1/rkszones/{zoneId}/portalDetectionProfiles

Use this API command to create portal detection and suppression profile.

Request
HideShow
Body
{
  "name": "My Profile",
  "description": "N/A",
  "portalDetectionPatterns": [
    {
      "name": "Android-Wifi",
      "userAgentPattern": ".*Android.*",
      "httpCode": 200,
      "httpResponseBody": "<HTML><HEAD><TITLE>title</TITLE></HEAD><BODY>It's a default pattern.</BODY></HTML>"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the portal detection and suppression profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the portal detection and suppression profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "portalDetectionPatterns": {
      "description": "The pattern profiles for portal detection and suppression",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "description": "Name of the portal detection and suppression pattern",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "patternType": {
            "description": "Portal detection and suppression pattern type",
            "type": "string",
            "enum": [
              "USER_AGENT"
            ]
          },
          "userAgentPattern": {
            "description": "Portal detection and suppression pattern for user agent",
            "type": "string",
            "maxLength": 256
          },
          "httpCode": {
            "description": "HTTP status codes",
            "type": "integer",
            "minimum": 100,
            "maximum": 599
          },
          "httpResponseBody": {
            "description": "HTTP response body",
            "type": "string",
            "maxLength": 1024
          }
        },
        "required": [
          "name",
          "userAgentPattern",
          "httpCode"
        ]
      }
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": "514b0440-9c8e-11e8-b35a-000000255086"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify portal detection and suppression profile by profile's ID

PUT/v11_1/rkszones/{zoneId}/portalDetectionProfiles/{id}

Use this API command to modify portal detection and suppression profile by profile’s ID.

Request
HideShow
Body
{
  "name": "My Profile",
  "description": "N/A",
  "portalDetectionPatterns": [
    {
      "name": "Android-Wifi",
      "userAgentPattern": ".*Android.*",
      "httpCode": 200,
      "httpResponseBody": "<HTML><HEAD><TITLE>title</TITLE></HEAD><BODY>It's a default pattern.</BODY></HTML>"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the portal detection and suppression profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the portal detection and suppression profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "portalDetectionPatterns": {
      "description": "The pattern profiles for portal detection and suppression",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "description": "Name of the portal detection and suppression pattern",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "patternType": {
            "description": "Portal detection and suppression pattern type",
            "type": "string",
            "enum": [
              "USER_AGENT"
            ]
          },
          "userAgentPattern": {
            "description": "Portal detection and suppression pattern for user agent",
            "type": "string",
            "maxLength": 256
          },
          "httpCode": {
            "description": "HTTP status codes",
            "type": "integer",
            "minimum": 100,
            "maximum": 599
          },
          "httpResponseBody": {
            "description": "HTTP response body",
            "type": "string",
            "maxLength": 1024
          }
        },
        "required": [
          "name",
          "userAgentPattern",
          "httpCode"
        ]
      }
    }
  },
  "required": [
    "name"
  ]
}
Response  204

Modify portal detection and suppression profile by profile's ID

PATCH/v11_1/rkszones/{zoneId}/portalDetectionProfiles/{id}

Use this API command to modify portal detection and suppression profile by profile’s ID.

Request
HideShow
Body
{
  "name": "My Profile",
  "description": "N/A",
  "portalDetectionPatterns": [
    {
      "name": "Android-Wifi",
      "userAgentPattern": ".*Android.*",
      "httpCode": 200,
      "httpResponseBody": "<HTML><HEAD><TITLE>title</TITLE></HEAD><BODY>It's a default pattern.</BODY></HTML>"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the portal detection and suppression profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the portal detection and suppression profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "portalDetectionPatterns": {
      "description": "The pattern profiles for portal detection and suppression",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "description": "Name of the portal detection and suppression pattern",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "patternType": {
            "description": "Portal detection and suppression pattern type",
            "type": "string",
            "enum": [
              "USER_AGENT"
            ]
          },
          "userAgentPattern": {
            "description": "Portal detection and suppression pattern for user agent",
            "type": "string",
            "maxLength": 256
          },
          "httpCode": {
            "description": "HTTP status codes",
            "type": "integer",
            "minimum": 100,
            "maximum": 599
          },
          "httpResponseBody": {
            "description": "HTTP response body",
            "type": "string",
            "maxLength": 1024
          }
        },
        "required": [
          "name",
          "userAgentPattern",
          "httpCode"
        ]
      }
    }
  },
  "required": [
    "name"
  ]
}
Response  204

Delete portal detection and suppression profile by profile's ID

DELETE/v11_1/rkszones/{zoneId}/portalDetectionProfiles/{id}

Use this API command to delete portal detection and suppression profile by profile’s ID.

Response  204

Delete multiple portal detection and suppression profiles

DELETE/v11_1/rkszones/{zoneId}/portalDetectionProfiles

Use this API command to delete multiple portal detection and suppression profiles.

Request
HideShow
Body
{
  "idList": [
    "eac50e51-9a63-11e7-a68a-0a0027000000",
    "1b4950d1-99d9-11e7-a68a-0a0027000000"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

SCI

Retrieve SCI Profile list

GET/v11_1/sci/sciProfile

Use this API command to retrieve sciProfile list.

Response  200
HideShow
Body
{
  "list": [
    {
      "id": "fd61eb66-d0db-447d-a618-b32d140e80e7",
      "sciPriority": 1,
      "sciProfile": "SCI Profile 1",
      "sciSystemId": "SCI System ID 1",
      "sciServerHost": "172.17.33.36",
      "sciServerPort": "8883",
      "sciUser": "user",
      "sciPassword": "password"
    },
    {
      "id": "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739",
      "sciPriority": 2,
      "sciProfile": "SCI Profile 2",
      "sciSystemId": "SCI System ID 2",
      "sciServerHost": "172.17.33.37",
      "sciServerPort": "8883",
      "sciUser": "user",
      "sciPassword": "password"
    }
  ],
  "extra": {
    "sciEnabled": "true"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "UUID of the SCI profile for SZ/SCI interface",
            "type": "string"
          },
          "sciPriority": {
            "description": "Priority of the SCI profile for SZ/SCI interface",
            "type": "integer"
          },
          "sciProfile": {
            "description": "Profile name of the SCI profile for SZ/SCI interface",
            "type": "string"
          },
          "sciSystemId": {
            "description": "SCI system UUID of the SCI profile for SZ/SCI interface",
            "type": "string"
          },
          "sciServerHost": {
            "description": "SCI server host of the SCI profile for SZ/SCI interface",
            "type": "string"
          },
          "sciServerPort": {
            "description": "SCI server port of the SCI profile for SZ/SCI interface",
            "type": "string"
          },
          "sciUser": {
            "description": "SCI user name of the SCI profile for SZ/SCI interface",
            "type": "string"
          },
          "sciPassword": {
            "description": "SCI password of the SCI profile for SZ/SCI interface",
            "type": "string"
          }
        }
      }
    },
    "extra": {
      "type": "object",
      "properties": {
        "sciEnabled": {
          "description": "SCI password of the SCI profile for SZ/SCI interface",
          "type": "boolean"
        }
      }
    }
  }
}

Retrieve SCI Profile

GET/v11_1/sci/sciProfile/{id}

Use this API command to retrieve sciProfile.

Response  200
HideShow
Body
{
  "id": "fd61eb66-d0db-447d-a618-b32d140e80e7",
  "sciPriority": 1,
  "sciProfile": "SCI Profile 1",
  "sciSystemId": "SCI System ID 1",
  "sciServerHost": "172.17.33.36",
  "sciServerPort": "8883",
  "sciUser": "user",
  "sciPassword": "password"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "UUID of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciPriority": {
      "description": "Priority of the SCI profile for SZ/SCI interface",
      "type": "integer"
    },
    "sciProfile": {
      "description": "Profile name of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciSystemId": {
      "description": "SCI system UUID of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciServerHost": {
      "description": "SCI server host of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciServerPort": {
      "description": "SCI server port of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciUser": {
      "description": "SCI user name of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciPassword": {
      "description": "SCI password of the SCI profile for SZ/SCI interface",
      "type": "string"
    }
  }
}

Retrieve SCI Accepted Event Codes

GET/v11_1/sci/sciEventCode

Use this API command to retrieve SciAcceptedEventCodes.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "code": 202,
      "type": "clientJoin"
    },
    {
      "code": 204,
      "type": "clientDisconnect"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total SCI accepted event code count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more SCI accepted event codes after the currently displayed list",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first event code returned from the complete event code set",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "code": {
            "description": "SCI accepted event code",
            "type": "integer"
          },
          "type": {
            "description": "SCI accepted event type",
            "type": "string"
          }
        }
      }
    }
  }
}

Create SCI Profile

POST/v11_1/sci/sciProfile

Use this API command to create sciProfile.

Request
HideShow
Body
{
  "sciProfile": "SCI Profile 1",
  "sciSystemId": "SCI System ID 1",
  "sciServerHost": "172.17.33.36",
  "sciServerPort": "8883",
  "sciUser": "user",
  "sciPassword": "password"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "sciProfile": {
      "description": "Profile name of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciSystemId": {
      "description": "SCI system UUID of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciServerHost": {
      "description": "SCI server host of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciServerPort": {
      "description": "SCI server port of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciUser": {
      "description": "SCI user name of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciPassword": {
      "description": "SCI password of the SCI profile for SZ/SCI interface",
      "type": "string"
    }
  },
  "required": [
    "sciProfile",
    "sciSystemId",
    "sciServerHost",
    "sciServerPort",
    "sciUser",
    "sciPassword"
  ]
}
Response  200
HideShow
Body
{
  "id": "fd61eb66-d0db-447d-a618-b32d140e80e7"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify SCI Accepted Event Codes

POST/v11_1/sci/sciEventCode

Use this API command to modify SciAcceptedEventCodes.

Request
HideShow
Body
{
  "sciAcceptedEventCodes": [
    202,
    204
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "sciAcceptedEventCodes": {
      "type": "array",
      "items": {
        "description": "SCI accepted event code",
        "type": "integer"
      }
    }
  },
  "required": [
    "sciAcceptedEventCodes"
  ]
}
Response  200

Modify SCI Profile

PATCH/v11_1/sci/sciProfile/{id}

Use this API command to modify sciProfile.

Request
HideShow
Body
{
  "sciProfile": "SCI Profile 1",
  "sciSystemId": "SCI System ID 1",
  "sciServerHost": "172.17.33.36",
  "sciServerPort": "8883",
  "sciUser": "user",
  "sciPassword": "password"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "UUID of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciProfile": {
      "description": "Profile name of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciSystemId": {
      "description": "SCI system UUID of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciServerHost": {
      "description": "SCI server host of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciServerPort": {
      "description": "SCI server port of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciUser": {
      "description": "SCI user name of the SCI profile for SZ/SCI interface",
      "type": "string"
    },
    "sciPassword": {
      "description": "SCI password of the SCI profile for SZ/SCI interface",
      "type": "string"
    }
  },
  "required": [
    "sciProfile",
    "sciSystemId",
    "sciServerHost",
    "sciServerPort",
    "sciUser",
    "sciPassword"
  ]
}
Response  200

Modify sciEnabled Setting

PATCH/v11_1/sci/sciEnabled

Use this API command to modify SCI settings is enabled or not.

Request
HideShow
Body
{
  "sciEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "sciEnabled": {
      "description": "Is SZ/SCI interface enabled or disabled",
      "type": "boolean"
    }
  },
  "required": [
    "sciEnabled"
  ]
}
Response  200

Delete SCI Profile

DELETE/v11_1/sci/sciProfile/{id}

Use this API command to delete sciProfile.

Response  200

Delete SCI Profile list

DELETE/v11_1/sci/sciProfile

Use this API command to delete sciProfile list.

Request
HideShow
Body
{
  "list": [
    {
      "id": "fd61eb66-d0db-447d-a618-b32d140e80e7"
    },
    {
      "id": "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "UUID of the SCI profile for SZ/SCI interface",
            "type": "string"
          }
        },
        "required": [
          "id"
        ]
      }
    }
  }
}
Response  200

Northbound Data Streaming

Retrieve Northbound Data Streaming Profile List

GET/v11_1/northboundDataStreamingProfileList

Use this API command to retrieve northbound Data Streaming Profile List

Response  200
HideShow
Body
{
  "list": [
    {
      "id": "fd61eb66-d0db-447d-a618-b32d140e80e7",
      "name": "Profile 1",
      "serverHost": "172.17.33.36",
      "serverPort": "8883",
      "user": "user",
      "password": "password",
      "systemId": "SystemID",
      "connectionStatus": "Connected",
      "dataTypes": [
        "SzConf",
        "Event"
      ],
      "northboundDataStreamingEnabled": true,
      "streamingByDomainZoneEnabled": true,
      "streamingDomainIds": [
        "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739",
        "fd61eb66-d0db-447d-a618-b32d140e80e7"
      ],
      "streamingZoneIds": [
        "fd61eb66-d0db-447d-a618-b32d140e80e7",
        "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739"
      ]
    },
    {
      "id": "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739",
      "name": "Profile 2",
      "serverHost": "172.17.33.37",
      "serverPort": "8883",
      "user": "user",
      "password": "password",
      "systemId": "SystemID",
      "connectionStatus": "Connected",
      "dataTypes": [
        "SzConf",
        "Event"
      ],
      "northboundDataStreamingEnabled": true,
      "streamingByDomainZoneEnabled": true,
      "streamingDomainIds": [
        "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739",
        "fd61eb66-d0db-447d-a618-b32d140e80e7"
      ],
      "streamingZoneIds": [
        "fd61eb66-d0db-447d-a618-b32d140e80e7",
        "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739"
      ]
    }
  ],
  "extra": {
    "northboundDataStreamingEnabled": true,
    "streamingByDomainZoneEnabled": true,
    "streamingDomainIds": [
      "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739",
      "fd61eb66-d0db-447d-a618-b32d140e80e7"
    ],
    "streamingZoneIds": [
      "fd61eb66-d0db-447d-a618-b32d140e80e7",
      "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739"
    ]
  }
}
Schema
{
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "UUID of the Northbound Data Streaming profile for Northbound Data Streaming interface",
            "type": "string"
          },
          "name": {
            "description": "Profile name of the Northbound Data Streaming profile for Northbound Data Streaming interface",
            "type": "string"
          },
          "serverHost": {
            "description": "Server host of the Northbound Data Streaming profile for Northbound Data Streaming interface",
            "type": "string"
          },
          "serverPort": {
            "description": "Server port of the Northbound Data Streaming profile for Northbound Data Streaming interface",
            "type": "string"
          },
          "user": {
            "description": "User name of the Northbound Data Streaming profile for Northbound Data Streaming interface",
            "type": "string"
          },
          "password": {
            "description": "Password of the Northbound Data Streaming profile for Northbound Data Streaming interface",
            "type": "string"
          },
          "systemId": {
            "description": "System UUID of the Northbound Data Streaming profile for Northbound Data Streaming interface",
            "type": "string"
          },
          "connectionStatus": {
            "description": "Connection status of the Northbound Data Streaming Profile",
            "type": "string"
          },
          "dataTypes": {
            "description": "Subscribed data types of the Northbound Data Streaming Profile",
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            }
          },
          "northboundDataStreamingEnabled": {
            "description": "Is Northbound Data Streaming enabled or disabled",
            "type": "boolean"
          },
          "streamingByDomainZoneEnabled": {
            "description": "Is Northbound Data Streaming enabled by domain/zone settings",
            "type": "boolean"
          },
          "streamingDomainIds": {
            "description": "Domain Ids for 'streamingByDomainZoneEnabled' settings",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "streamingZoneIds": {
            "description": "Zone Ids for 'streamingByDomainZoneEnabled' settings",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "extra": {
      "type": "object",
      "properties": {
        "northboundDataStreamingEnabled": {
          "description": "Is Northbound Data Streaming enabled or disabled",
          "type": "boolean"
        },
        "streamingByDomainZoneEnabled": {
          "description": "Is Northbound Data Streaming enabled by domain/zone settings",
          "type": "boolean"
        },
        "streamingDomainIds": {
          "description": "Domain Ids for 'streamingByDomainZoneEnabled' settings",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "streamingZoneIds": {
          "description": "Zone Ids for 'streamingByDomainZoneEnabled' settings",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve Northbound Data Streaming Profile

GET/v11_1/northboundDataStreamingProfile/{id}

Use this API command to retrieve northbound Data Streaming Profile

Response  200
HideShow
Body
{
  "name": "Profile 1",
  "serverHost": "172.17.33.36",
  "serverPort": "8883",
  "user": "user",
  "password": "password",
  "systemId": "SystemID",
  "connectionStatus": "Connected",
  "dataTypes": [
    "SzConf",
    "Event"
  ],
  "northboundDataStreamingEnabled": true,
  "streamingByDomainZoneEnabled": true,
  "streamingDomainIds": [
    "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739",
    "fd61eb66-d0db-447d-a618-b32d140e80e7"
  ],
  "streamingZoneIds": [
    "fd61eb66-d0db-447d-a618-b32d140e80e7",
    "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "UUID of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string"
    },
    "name": {
      "description": "Profile name of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string"
    },
    "serverHost": {
      "description": "Server host of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string"
    },
    "serverPort": {
      "description": "Server port of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string"
    },
    "user": {
      "description": "User name of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string"
    },
    "password": {
      "description": "Password of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string"
    },
    "systemId": {
      "description": "System UUID of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string"
    },
    "connectionStatus": {
      "description": "Connection status of the Northbound Data Streaming Profile",
      "type": "string"
    },
    "dataTypes": {
      "description": "Subscribed data types of the Northbound Data Streaming Profile",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "northboundDataStreamingEnabled": {
      "description": "Is Northbound Data Streaming enabled or disabled",
      "type": "boolean"
    },
    "streamingByDomainZoneEnabled": {
      "description": "Is Northbound Data Streaming enabled by domain/zone settings",
      "type": "boolean"
    },
    "streamingDomainIds": {
      "description": "Domain Ids for 'streamingByDomainZoneEnabled' settings",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "streamingZoneIds": {
      "description": "Zone Ids for 'streamingByDomainZoneEnabled' settings",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Retrieve Northbound Data Streaming Accepted Event Codes

GET/v11_1/northboundDataStreamingEventCodes

Use this API command to retrieve NorthboundDataStreamingEventCodes.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "code": 202,
      "type": "clientJoin"
    },
    {
      "code": 204,
      "type": "clientDisconnect"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total Northbound Data Streaming accepted event code count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more Northbound Data Streaming accepted event codes after the currently displayed list",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first event code returned from the complete event code set",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "code": {
            "description": "Northbound Data Streaming accepted event code",
            "type": "integer"
          },
          "type": {
            "description": "Northbound Data Streaming accepted event type",
            "type": "string"
          }
        }
      }
    }
  }
}

Create Northbound Data Streaming Profile

POST/v11_1/northboundDataStreamingProfile

Use this API command to create northbound Data Streaming Profile

Request
HideShow
Body
{
  "name": "Profile 1",
  "serverHost": "172.17.33.36",
  "serverPort": "8883",
  "user": "user",
  "password": "password",
  "systemId": "SystemID",
  "dataTypes": [
    "SzConf",
    "Event"
  ],
  "northboundDataStreamingEnabled": true,
  "streamingByDomainZoneEnabled": true,
  "streamingDomainIds": [
    "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739",
    "fd61eb66-d0db-447d-a618-b32d140e80e7"
  ],
  "streamingZoneIds": [
    "fd61eb66-d0db-447d-a618-b32d140e80e7",
    "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Profile name of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string",
      "maxLength": 64
    },
    "serverHost": {
      "description": "Server host of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string"
    },
    "serverPort": {
      "description": "Server port of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string"
    },
    "user": {
      "description": "User name of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string",
      "maxLength": 32
    },
    "password": {
      "description": "Password of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string",
      "maxLength": 128
    },
    "systemId": {
      "description": "System UUID of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string"
    },
    "dataTypes": {
      "description": "Subscribed data types of the Northbound Data Streaming Profile",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string",
        "enum": [
          "ApStatus",
          "ApReport",
          "ApMesh",
          "ApHccdReport",
          "ApRogue",
          "ApAvc",
          "ApClientStatus",
          "ApWiredClient",
          "Event",
          "SzConf",
          "Alarm",
          "PciReport",
          "SwitchReport",
          "RealtimeSwitchStatus",
          "SwitchConf",
          "ApPeer",
          "ClientData",
          "SwitchDetail",
          "SzDomainConf",
          "SzZoneConf",
          "SzApGroupConf",
          "SzApConf",
          "SzWlanConf",
          "SzSystemConf"
        ]
      }
    },
    "northboundDataStreamingEnabled": {
      "description": "Is Northbound Data Streaming enabled or disabled",
      "type": "boolean",
      "default": false
    },
    "streamingByDomainZoneEnabled": {
      "description": "Is Northbound Data Streaming enabled by domain/zone settings",
      "type": "boolean",
      "default": false
    },
    "streamingDomainIds": {
      "description": "Domain Ids for 'streamingByDomainZoneEnabled' settings",
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": []
    },
    "streamingZoneIds": {
      "description": "Zone Ids for 'streamingByDomainZoneEnabled' settings",
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": []
    }
  },
  "required": [
    "name",
    "serverHost",
    "serverPort",
    "user",
    "password",
    "systemId"
  ]
}
Response  200
HideShow
Body
{
  "id": "fd61eb66-d0db-447d-a618-b32d140e80e7"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Northbound Data Streaming Settings

PUT/v11_1/northboundDataStreamingSettings

Use this API command to modify Northbound Data Streaming Settings.

Request
HideShow
Body
{
  "northboundDataStreamingEnabled": true,
  "streamingByDomainZoneEnabled": true,
  "streamingDomainIds": [
    "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739",
    "fd61eb66-d0db-447d-a618-b32d140e80e7"
  ],
  "streamingZoneIds": [
    "fd61eb66-d0db-447d-a618-b32d140e80e7",
    "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "northboundDataStreamingEnabled": {
      "description": "Is Northbound Data Streaming enabled or disabled",
      "type": "boolean"
    },
    "streamingByDomainZoneEnabled": {
      "description": "Is Northbound Data Streaming enabled by domain/zone settings",
      "type": "boolean"
    },
    "streamingDomainIds": {
      "description": "Domain Ids for 'streamingByDomainZoneEnabled' settings",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "streamingZoneIds": {
      "description": "Zone Ids for 'streamingByDomainZoneEnabled' settings",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "northboundDataStreamingEnabled",
    "streamingByDomainZoneEnabled"
  ]
}
Response  200

Modify Northbound Data Streaming Accepted Event Codes

PUT/v11_1/northboundDataStreamingEventCodes

Use this API command to modify NorthboundDataStreamingEventCodes.

Request
HideShow
Body
{
  "northboundDataStreamingAcceptedEventCodes": [
    202,
    204
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "northboundDataStreamingAcceptedEventCodes": {
      "type": "array",
      "items": {
        "description": "Northbound Data Streaming accepted event code",
        "type": "integer"
      }
    }
  },
  "required": [
    "northboundDataStreamingAcceptedEventCodes"
  ]
}
Response  200

Update Northbound Data Streaming Profile

PUT/v11_1/northboundDataStreamingProfile/{id}

Use this API command to update northbound Data Streaming Profile

Request
HideShow
Body
{
  "name": "Profile 1",
  "serverHost": "172.17.33.36",
  "serverPort": "8883",
  "user": "user",
  "password": "password",
  "systemId": "SystemID",
  "dataTypes": [
    "SzConf",
    "Event"
  ],
  "northboundDataStreamingEnabled": true,
  "streamingByDomainZoneEnabled": true,
  "streamingDomainIds": [
    "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739",
    "fd61eb66-d0db-447d-a618-b32d140e80e7"
  ],
  "streamingZoneIds": [
    "fd61eb66-d0db-447d-a618-b32d140e80e7",
    "168acbaf-b4ff-4dc9-8ba4-7f1ab28b2739"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Profile name of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string",
      "maxLength": 64
    },
    "serverHost": {
      "description": "Server host of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string"
    },
    "serverPort": {
      "description": "Server port of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string"
    },
    "user": {
      "description": "User name of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string",
      "maxLength": 32
    },
    "password": {
      "description": "Password of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string",
      "maxLength": 128
    },
    "systemId": {
      "description": "System UUID of the Northbound Data Streaming profile for Northbound Data Streaming interface",
      "type": "string"
    },
    "dataTypes": {
      "description": "Subscribed data types of the Northbound Data Streaming Profile",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string",
        "enum": [
          "ApStatus",
          "ApReport",
          "ApMesh",
          "ApHccdReport",
          "ApRogue",
          "ApAvc",
          "ApClientStatus",
          "ApWiredClient",
          "Event",
          "SzConf",
          "Alarm",
          "PciReport",
          "SwitchReport",
          "RealtimeSwitchStatus",
          "SwitchConf",
          "ApPeer",
          "ClientData",
          "SwitchDetail",
          "SzDomainConf",
          "SzZoneConf",
          "SzApGroupConf",
          "SzApConf",
          "SzWlanConf",
          "SzSystemConf"
        ]
      }
    },
    "northboundDataStreamingEnabled": {
      "description": "Is Northbound Data Streaming enabled or disabled",
      "type": "boolean"
    },
    "streamingByDomainZoneEnabled": {
      "description": "Is Northbound Data Streaming enabled by domain/zone settings",
      "type": "boolean"
    },
    "streamingDomainIds": {
      "description": "Domain Ids for 'streamingByDomainZoneEnabled' settings",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "streamingZoneIds": {
      "description": "Zone Ids for 'streamingByDomainZoneEnabled' settings",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "name",
    "serverHost",
    "serverPort",
    "user",
    "password",
    "systemId"
  ]
}
Response  200

Delete Northbound Data Streaming Profile

DELETE/v11_1/northboundDataStreamingProfile/{id}

Use this API command to delete northbound Data Streaming Profile

Response  200

Real Time Location Service Profile

Get RTLS Profile by profile's ID

GET/v11_1/rkszones/{zoneId}/realTimeLocationService/{id}

Use this API command to Get RTLS Profile by profile’s ID.

Response  200
HideShow
Body
{
  "ekahauEnabled": true,
  "ekahauIp": "1.1.1.1",
  "ekahauPort": 9527,
  "stanleyEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "ekahauEnabled": {
      "description": "Eekahau Location Service Enabled",
      "type": "boolean"
    },
    "ekahauIp": {
      "description": "Eekahau Location Server IP",
      "type": "string"
    },
    "ekahauPort": {
      "description": "Eekahau Location Server Port",
      "type": "integer"
    },
    "stanleyEnabled": {
      "description": "Stanley Location Service Enabled",
      "type": "boolean"
    }
  },
  "required": [
    "ekahauEnabled",
    "stanleyEnabled"
  ]
}

Get RTLS Profile by zone ID

GET/v11_1/rkszones/{zoneId}/realTimeLocationService

Use this API command to Get RTLS Profile by zone ID.

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "ekahauEnabled": {
            "description": "Eekahau Location Service Enabled",
            "type": "boolean"
          },
          "ekahauIp": {
            "description": "Eekahau Location Server IP",
            "type": "string"
          },
          "ekahauPort": {
            "description": "Eekahau Location Server Port",
            "type": "integer"
          },
          "stanleyEnabled": {
            "description": "Stanley Location Service Enabled",
            "type": "boolean"
          }
        },
        "required": [
          "ekahauEnabled",
          "stanleyEnabled"
        ]
      }
    }
  }
}

Create RTLS Profile

POST/v11_1/rkszones/{zoneId}/realTimeLocationService

Use this API command to create RTLS Profile.

Request
HideShow
Body
{
  "ekahauEnabled": true,
  "ekahauIp": "1.1.1.1",
  "ekahauPort": 9527,
  "stanleyEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "ekahauEnabled": {
      "description": "Eekahau Location Service Enabled",
      "type": "boolean"
    },
    "ekahauIp": {
      "description": "Eekahau Location Server IP",
      "type": "string"
    },
    "ekahauPort": {
      "description": "Eekahau Location Server Port",
      "type": "integer"
    },
    "stanleyEnabled": {
      "description": "Stanley Location Service Enabled",
      "type": "boolean"
    }
  },
  "required": [
    "ekahauEnabled",
    "stanleyEnabled"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify RTLS Profile by profile's ID

PUT/v11_1/rkszones/{zoneId}/realTimeLocationService/{id}

Use this API command to Modify RTLS Profile by profile’s ID.

Request
HideShow
Body
{
  "ekahauEnabled": true,
  "ekahauIp": "1.1.1.2",
  "ekahauPort": 9528,
  "stanleyEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "ekahauEnabled": {
      "type": "boolean"
    },
    "ekahauIp": {
      "type": "string"
    },
    "ekahauPort": {
      "type": "integer"
    },
    "stanleyEnabled": {
      "type": "boolean"
    }
  }
}
Response  200

Delete RTLS Profile by profile's ID

DELETE/v11_1/rkszones/{zoneId}/realTimeLocationService/{id}

Use this API command to Delete RTLS Profile by profile’s ID.

Response  204

Geofence Profile

Retrieve Geofence Profile

GET/v11_1/rkszones/{zoneId}/geofenceProfiles/{id}

Use this API command to retrieve a Geofence Profile.

Response  200
HideShow
Body
{
  "id": "a2df9310-0ac0-11e6-9411-56847afe9799",
  "name": "geo-1",
  "zoneId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "description": "GeofenceProfileDesc2",
  "radiusMeter": "30",
  "locationList": [
    {
      "name": "geo-1-L-1",
      "description": "geo-1-L-1",
      "location": "30,123"
    },
    {
      "name": "geo-1-L-2",
      "description": "geo-1-L-2",
      "location": "30,121"
    },
    {
      "name": "geo-1-L-3",
      "description": "geo-1-L-3",
      "location": "30,119"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Geofence Profile's id",
      "type": "string"
    },
    "name": {
      "description": "Geofence Profile's name",
      "type": "string"
    },
    "zoneId": {
      "description": "The zone which Geofence Profile belong to",
      "type": "string"
    },
    "description": {
      "description": "Geofence Profile's description",
      "type": "string"
    },
    "radiusMeter": {
      "description": "Geofence Profile's radius",
      "type": "integer"
    },
    "locationList": {
      "type": "array",
      "description": "Geofence Profile's location list",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "description": "Geofence Profile's location name",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Geofence Profile's location description",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "location": {
            "description": "Geofence Profile's location Latitude and longitude",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve Geofence Profile List

GET/v11_1/rkszones/{zoneId}/geofenceProfiles

Query Geofence Profile with specified filters.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "a2df9310-0ac0-11e6-9411-56847afe9799",
      "name": "geo-1",
      "zoneId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "description": "GeofenceProfileDesc1",
      "radiusMeter": "30",
      "locationList": [
        {
          "name": "geo-1-L-1",
          "description": "geo-1-L-1",
          "location": "30,123"
        },
        {
          "name": "geo-1-L-2",
          "description": "geo-1-L-2",
          "location": "30,121"
        },
        {
          "name": "geo-1-L-3",
          "description": "geo-1-L-3",
          "location": "30,119"
        }
      ]
    },
    {
      "id": "c9df9310-0ac0-11e6-9411-56847afe9799",
      "name": "geo-2",
      "zoneId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "description": "GeofenceProfileDesc2",
      "radiusMeter": "30",
      "locationList": [
        {
          "name": "geo-2-L-1",
          "description": "geo-2-L-1",
          "location": "20,123"
        },
        {
          "name": "geo-2-L-2",
          "description": "geo-2-L-2",
          "location": "20,121"
        },
        {
          "name": "geo-2-L-3",
          "description": "geo-2-L-3",
          "location": "20,119"
        }
      ]
    }
  ]
}
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": "Geofence Profile's id",
            "type": "string"
          },
          "name": {
            "description": "Geofence Profile's name",
            "type": "string"
          },
          "zoneId": {
            "description": "The zone which Geofence Profile belong to",
            "type": "string"
          },
          "description": {
            "description": "Geofence Profile's description",
            "type": "string"
          },
          "radiusMeter": {
            "description": "Geofence Profile's radius",
            "type": "integer"
          },
          "locationList": {
            "type": "array",
            "description": "Geofence Profile's location list",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "name": {
                  "description": "Geofence Profile's location name",
                  "type": "string",
                  "minLength": 2,
                  "maxLength": 32,
                  "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
                },
                "description": {
                  "description": "Geofence Profile's location description",
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 64
                },
                "location": {
                  "description": "Geofence Profile's location Latitude and longitude",
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Create Geofence Profile

POST/v11_1/rkszones/{zoneId}/geofenceProfiles

Use this API command to create a Geofence Profile.

Request
HideShow
Body
{
  "name": "geo-1",
  "description": "GeofenceProfileDesc2",
  "radiusMeter": "30",
  "locationList": [
    {
      "name": "geo-1-L-1",
      "description": "geo-1-L-1",
      "location": "30,123"
    },
    {
      "name": "geo-1-L-2",
      "description": "geo-1-L-2",
      "location": "30,121"
    },
    {
      "name": "geo-1-L-3",
      "description": "geo-1-L-3",
      "location": "30,119"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Geofence Profile's name",
      "type": "string"
    },
    "description": {
      "description": "Geofence Profile's description",
      "type": "string"
    },
    "radiusMeter": {
      "description": "Geofence Profile's radius (1 - 100) meter",
      "type": "integer"
    },
    "locationList": {
      "type": "array",
      "description": "Geofence Profile's location list",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "description": "Geofence Profile's location name",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Geofence Profile's location description",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "location": {
            "description": "Geofence Profile's location Latitude and longitude",
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "name",
    "radiusMeter",
    "locationList"
  ]
}
Response  201
HideShow
Body
{
  "id": "05f0503b-cfd9-414e-b37d-72a96f0f4288"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Geofence Profile

PUT/v11_1/rkszones/{zoneId}/geofenceProfiles/{id}

Use this API command to update a Geofence Profile.

Request
HideShow
Body
{
  "name": "geo-1",
  "description": "GeofenceProfileDesc2",
  "radiusMeter": "30",
  "locationList": [
    {
      "name": "geo-1-L-1",
      "description": "geo-1-L-1",
      "location": "30,123"
    },
    {
      "name": "geo-1-L-2",
      "description": "geo-1-L-2",
      "location": "30,121"
    },
    {
      "name": "geo-1-L-3",
      "description": "geo-1-L-3",
      "location": "30,119"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Geofence Profile's name",
      "type": "string"
    },
    "description": {
      "description": "Geofence Profile's description",
      "type": "string"
    },
    "radiusMeter": {
      "description": "Geofence Profile's radius (1 - 100) meter",
      "type": "integer"
    },
    "locationList": {
      "type": "array",
      "description": "Geofence Profile's location list",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "description": "Geofence Profile's location name",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Geofence Profile's location description",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "location": {
            "description": "Geofence Profile's location Latitude and longitude",
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "name",
    "radiusMeter",
    "locationList"
  ]
}
Response  200

Delete Geofence Profile

DELETE/v11_1/rkszones/{zoneId}/geofenceProfiles/{id}

Use this API command to delete a Geofence Profile.

Response  204

Delete Geofence Profile List

DELETE/v11_1/rkszones/{zoneId}/geofenceProfiles

Use this API command to delete a list of Geofence Profile.

Request
HideShow
Body
{
  "idList": [
    "eac50e51-4a63-11e7-a68a-0a0027000000",
    "1b4950d1-49d9-11e7-a68a-0a0027000000"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Access Point APP

Retrieve AP Summary

GET/v11_1/aps/lineman

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

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

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
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "mac": "00:11:22:33:44:55",
      "name": "apName",
      "latitude": "22.3",
      "longitude": "114",
      "location": "location",
      "configState": "newConfig",
      "alarms": {
        "criticalCount": 0,
        "majorCount": 1,
        "minorCount": 7,
        "warningCount": 0
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total AP count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates if there are more APs after the currently displayed list",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first AP returned out of the complete AP list",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "mac": {
            "description": "MAC address of the AP",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "name": {
            "description": "Name of the AP",
            "type": "string"
          },
          "latitude": {
            "description": "Latitude coordinate (in decimal format) of the AP",
            "type": "number"
          },
          "longitude": {
            "description": "Longitude coordinate (in decimal format) of the AP",
            "type": "number"
          },
          "configState": {
            "description": "State of the AP configuration",
            "type": "string",
            "enum": [
              "newConfig",
              "fwApplied",
              "fwDownloaded",
              "fwFailed",
              "configApplied",
              "completed",
              "configFailed"
            ]
          },
          "location": {
            "description": "Location of the AP. This is a free format text description that indicates the location of the AP.",
            "type": "string"
          },
          "alarms": {
            "description": "Alarm counters by severity on the AP",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "criticalCount": {
                "description": "Critical alarm count",
                "type": "integer",
                "format": "int64"
              },
              "majorCount": {
                "description": "Major alarm count",
                "type": "integer",
                "format": "int64"
              },
              "minorCount": {
                "description": "Minor alarm count",
                "type": "integer",
                "format": "int64"
              },
              "warningCount": {
                "description": "Warning alarm count",
                "type": "integer",
                "format": "int64"
              }
            }
          }
        }
      }
    }
  }
}

Retrieve Total AP Count

GET/v11_1/aps/totalCount

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

URI Parameters
HideShow
zoneId
string (optional) 

filter AP total count by zone. Default: current logon domain

domainId
string (optional) 

filter AP total count by domain. Default: current logon domain

Response  200

Download Workflow File

GET/v11_1/lineman/workflow

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

Response  200
HideShow
Headers
Content-Type: application/octet-stream

Upload Workflow File

PUT/v11_1/lineman/workflow

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

Request
HideShow
Headers
Content-Type: multipart/form-data
Response  204

Wireless Client

Retrieve Total Client Count

GET/v11_1/aps/{apMac}/operational/client/totalCount

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

Response  200

Bulk Deauth Client

POST/v11_1/clients/bulkDeauth

Use this API command to bulk deauth client.

Request
HideShow
Body
{
  "clientList": [
    {
      "apMac": "AB:CD:00:00:00:0E",
      "mac": "20:80:00:00:1F:40"
    },
    {
      "apMac": "AB:CD:00:00:00:0D",
      "mac": "20:90:00:00:23:28"
    }
  ]
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "clientList": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "mac": {
            "description": "Client Mac",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "apMac": {
            "description": "AP Mac",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          }
        },
        "required": [
          "mac",
          "apMac"
        ]
      },
      "minItems": 1,
      "uniqueItems": true
    }
  }
}
Response  204

Bulk Disconnect Client

POST/v11_1/clients/bulkDisconnect

Use this API command to bulk disconnect client.

Request
HideShow
Body
{
  "clientList": [
    {
      "apMac": "AB:CD:00:00:00:0E",
      "mac": "20:80:00:00:1F:40"
    },
    {
      "apMac": "AB:CD:00:00:00:0D",
      "mac": "20:90:00:00:23:28"
    }
  ]
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "clientList": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "mac": {
            "description": "Client Mac",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "apMac": {
            "description": "AP Mac",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          }
        },
        "required": [
          "mac",
          "apMac"
        ]
      },
      "minItems": 1,
      "uniqueItems": true
    }
  }
}
Response  204

Query Client By Wlan Name

POST/v11_1/clients/byWlanName/{wlanname}

Use this API command to query client by wlan name. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "apMac": "58:B6:33:37:D4:E0",
      "apName": "R710_Box_Up_Pink",
      "hostname": "Nolan_DELL_Laptop",
      "status": "AUTHORIZED",
      "authStatus": "AUTHORIZED",
      "alerts": null,
      "osType": "Windows 7/Vista",
      "deviceType": "Laptop",
      "osVendorType": "Windows",
      "modelName": "Windows 7/Vista",
      "ipAddress": "10.11.0.86",
      "ipv6Address": "2001:b030:2516:164:7074:3f14:f0d9:c939",
      "clientMac": "00:24:D7:89:36:A0",
      "ssid": "NolanWPATest",
      "txBytes": 2099158501,
      "rxBytes": 73731395,
      "txRxBytes": 2172889896,
      "uplink": 73731395,
      "downlink": 2099158501,
      "traffic": 2172889896,
      "uplinkRate": 131194,
      "downlinkRate": 3735157,
      "rssi": -47,
      "snr": 58,
      "radioType": "11a/n/ac",
      "vlan": 1,
      "channel": 36,
      "userName": null,
      "authMethod": "Standard+Open",
      "encryptionMethod": "WPA2-AES",
      "controlPlaneName": "node232",
      "dataPlaneName": null,
      "rxFrames": 952977,
      "txFrames": 1729632,
      "txDropDataFrames": 4,
      "sessionStartTime": 1487400391000,
      "speedflex": 0,
      "wlanType": "0",
      "zoneId": "d6ad32aa-c400-4005-b9c2-1d5b90e44139",
      "zoneVersion": "3.5.0.99.1132"
    },
    {
      "apMac": "74:3E:2B:35:ED:80",
      "apName": "R700_ED:80_123",
      "hostname": "mit-E5430",
      "status": "AUTHORIZED",
      "authStatus": "AUTHORIZED",
      "alerts": null,
      "osType": "Windows 7/Vista",
      "deviceType": "Laptop",
      "osVendorType": "Windows",
      "modelName": "Windows 7/Vista",
      "ipAddress": "192.168.10.26",
      "ipv6Address": "3075:100::d597:4368:1acf:49f3",
      "clientMac": "24:77:03:E7:53:D0",
      "ssid": "qa-mit-kpi-231",
      "txBytes": 8336498864,
      "rxBytes": 150640661,
      "txRxBytes": 8487139525,
      "uplink": 150640661,
      "downlink": 8336498864,
      "traffic": 8487139525,
      "uplinkRate": 5589,
      "downlinkRate": 309320,
      "rssi": -32,
      "snr": 80,
      "radioType": "11g/n",
      "vlan": 1,
      "channel": 11,
      "userName": null,
      "authMethod": "Standard+Open",
      "encryptionMethod": "WPA2-AES",
      "controlPlaneName": "node232",
      "dataPlaneName": null,
      "rxFrames": 2830943,
      "txFrames": 5936625,
      "txDropDataFrames": 60315,
      "sessionStartTime": 1487555453000,
      "speedflex": 0,
      "wlanType": "0",
      "zoneId": "6d6c9cbb-45ba-48e4-a6c9-af28b286a507",
      "zoneVersion": "3.5.0.99.1132"
    }
  ]
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "totalCount": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for client list",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "role": {
            "type": "string"
          },
          "ipv6Address": {
            "type": "string"
          },
          "clientMac": {
            "type": "string"
          },
          "dataPlaneName": {
            "type": "string"
          },
          "channel": {
            "type": "integer"
          },
          "ssid": {
            "type": "string"
          },
          "encryptionMethod": {
            "type": "string"
          },
          "apName": {
            "type": "string"
          },
          "traffic": {
            "type": "integer",
            "format": "int64"
          },
          "uplink": {
            "type": "integer",
            "format": "int64"
          },
          "downlink": {
            "type": "integer",
            "format": "int64"
          },
          "txRxBytes": {
            "type": "integer",
            "format": "int64"
          },
          "txDropDataFrames": {
            "type": "integer",
            "format": "int64"
          },
          "txFrames": {
            "type": "integer",
            "format": "int64"
          },
          "hostname": {
            "type": "string"
          },
          "vlan": {
            "type": "integer"
          },
          "vni": {
            "type": "integer"
          },
          "controlPlaneName": {
            "type": "string"
          },
          "rxFrames": {
            "type": "integer",
            "format": "int64"
          },
          "wlanType": {
            "type": "string"
          },
          "osType": {
            "type": "string"
          },
          "deviceType": {
            "type": "string"
          },
          "osVendorType": {
            "type": "string"
          },
          "modelName": {
            "type": "string"
          },
          "speedflex": {
            "type": "integer"
          },
          "rssi": {
            "type": "integer"
          },
          "rxBytes": {
            "type": "integer",
            "format": "int64"
          },
          "ipAddress": {
            "type": "string"
          },
          "sessionStartTime": {
            "type": "integer",
            "format": "int64"
          },
          "apMac": {
            "type": "string"
          },
          "userName": {
            "type": "string"
          },
          "userRoleId": {
            "type": "string"
          },
          "userRoleName": {
            "type": "string"
          },
          "alerts": {
            "type": "integer"
          },
          "txBytes": {
            "type": "integer",
            "format": "int64"
          },
          "snr": {
            "type": "integer"
          },
          "authMethod": {
            "type": "string"
          },
          "radioType": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "zoneVersion": {
            "type": "string"
          },
          "authStatus": {
            "type": "string"
          },
          "uplinkRate": {
            "type": "integer",
            "format": "int64"
          },
          "downlinkRate": {
            "type": "integer",
            "format": "int64"
          },
          "txRatebps": {
            "type": "integer"
          },
          "zoneId": {
            "type": "string"
          },
          "bssid": {
            "type": "string"
          },
          "tcWithQuotaList": {
            "type": "array",
            "items": {
              "additionalProperties": false,
              "type": "object",
              "properties": {
                "tcName": {
                  "type": "string"
                },
                "tcMaxQuota": {
                  "type": "string"
                },
                "tcRemainingQuota": {
                  "type": "string"
                }
              }
            }
          },
          "cpeMac": {
            "type": "string"
          },
          "medianTxMCSRate": {
            "type": "integer",
            "format": "int64"
          },
          "medianRxMCSRate": {
            "type": "integer",
            "format": "int64"
          }
        }
      }
    }
  }
}

Deauth Client

POST/v11_1/clients/deauth

Use this API command to deauth client.

Request
HideShow
Body
{
  "mac": "E8:99:C4:AD:7C:38",
  "apMac": "C0:8A:DE:24:FA:00"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "mac": {
      "description": "Client Mac",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
    },
    "apMac": {
      "description": "AP Mac",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
    }
  },
  "required": [
    "mac",
    "apMac"
  ]
}
Response  204

Disconnect client

POST/v11_1/clients/disconnect

Use this API command to disconnect client.

Request
HideShow
Body
{
  "mac": "E8:99:C4:AD:7C:38",
  "apMac": "C0:8A:DE:24:FA:00"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "mac": {
      "description": "Client Mac",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
    },
    "apMac": {
      "description": "AP Mac",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
    }
  },
  "required": [
    "mac",
    "apMac"
  ]
}
Response  204

Query Clients

POST/v11_1/query/client

Query clients with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "apMac": "58:B6:33:37:D4:E0",
      "apName": "R710_Box_Up_Pink",
      "hostname": "Nolan_DELL_Laptop",
      "status": "AUTHORIZED",
      "authStatus": "AUTHORIZED",
      "alerts": null,
      "osType": "Windows 7/Vista",
      "deviceType": "Laptop",
      "osVendorType": "Windows",
      "modelName": "Windows 7/Vista",
      "ipAddress": "10.11.0.86",
      "ipv6Address": "2001:b030:2516:164:7074:3f14:f0d9:c939",
      "clientMac": "00:24:D7:89:36:A0",
      "ssid": "NolanWPATest",
      "txBytes": 2099158501,
      "rxBytes": 73731395,
      "txRxBytes": 2172889896,
      "uplink": 73731395,
      "downlink": 2099158501,
      "traffic": 2172889896,
      "uplinkRate": 131194,
      "downlinkRate": 3735157,
      "rssi": -47,
      "snr": 58,
      "radioType": "11a/n/ac",
      "vlan": 1,
      "channel": 36,
      "userName": null,
      "authMethod": "Standard+Open",
      "encryptionMethod": "WPA2-AES",
      "controlPlaneName": "node232",
      "dataPlaneName": null,
      "rxFrames": 952977,
      "txFrames": 1729632,
      "txDropDataFrames": 4,
      "sessionStartTime": 1487400391000,
      "speedflex": 0,
      "wlanType": "0",
      "zoneId": "d6ad32aa-c400-4005-b9c2-1d5b90e44139",
      "zoneVersion": "3.5.0.99.1132"
    },
    {
      "apMac": "74:3E:2B:35:ED:80",
      "apName": "R700_ED:80_123",
      "hostname": "mit-E5430",
      "status": "AUTHORIZED",
      "authStatus": "AUTHORIZED",
      "alerts": null,
      "osType": "Windows 7/Vista",
      "deviceType": "Laptop",
      "osVendorType": "Windows",
      "modelName": "Windows 7/Vista",
      "ipAddress": "192.168.10.26",
      "ipv6Address": "3075:100::d597:4368:1acf:49f3",
      "clientMac": "24:77:03:E7:53:D0",
      "ssid": "qa-mit-kpi-231",
      "txBytes": 8336498864,
      "rxBytes": 150640661,
      "txRxBytes": 8487139525,
      "uplink": 150640661,
      "downlink": 8336498864,
      "traffic": 8487139525,
      "uplinkRate": 5589,
      "downlinkRate": 309320,
      "rssi": -32,
      "snr": 80,
      "radioType": "11g/n",
      "vlan": 1,
      "channel": 11,
      "userName": null,
      "authMethod": "Standard+Open",
      "encryptionMethod": "WPA2-AES",
      "controlPlaneName": "node232",
      "dataPlaneName": null,
      "rxFrames": 2830943,
      "txFrames": 5936625,
      "txDropDataFrames": 60315,
      "sessionStartTime": 1487555453000,
      "speedflex": 0,
      "wlanType": "0",
      "zoneId": "6d6c9cbb-45ba-48e4-a6c9-af28b286a507",
      "zoneVersion": "3.5.0.99.1132"
    }
  ]
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "totalCount": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for client list",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "role": {
            "type": "string"
          },
          "ipv6Address": {
            "type": "string"
          },
          "clientMac": {
            "type": "string"
          },
          "dataPlaneName": {
            "type": "string"
          },
          "channel": {
            "type": "integer"
          },
          "ssid": {
            "type": "string"
          },
          "encryptionMethod": {
            "type": "string"
          },
          "apName": {
            "type": "string"
          },
          "traffic": {
            "type": "integer",
            "format": "int64"
          },
          "uplink": {
            "type": "integer",
            "format": "int64"
          },
          "downlink": {
            "type": "integer",
            "format": "int64"
          },
          "txRxBytes": {
            "type": "integer",
            "format": "int64"
          },
          "txDropDataFrames": {
            "type": "integer",
            "format": "int64"
          },
          "txFrames": {
            "type": "integer",
            "format": "int64"
          },
          "hostname": {
            "type": "string"
          },
          "vlan": {
            "type": "integer"
          },
          "vni": {
            "type": "integer"
          },
          "controlPlaneName": {
            "type": "string"
          },
          "rxFrames": {
            "type": "integer",
            "format": "int64"
          },
          "wlanType": {
            "type": "string"
          },
          "osType": {
            "type": "string"
          },
          "deviceType": {
            "type": "string"
          },
          "osVendorType": {
            "type": "string"
          },
          "modelName": {
            "type": "string"
          },
          "speedflex": {
            "type": "integer"
          },
          "rssi": {
            "type": "integer"
          },
          "rxBytes": {
            "type": "integer",
            "format": "int64"
          },
          "ipAddress": {
            "type": "string"
          },
          "sessionStartTime": {
            "type": "integer",
            "format": "int64"
          },
          "apMac": {
            "type": "string"
          },
          "userName": {
            "type": "string"
          },
          "userRoleId": {
            "type": "string"
          },
          "userRoleName": {
            "type": "string"
          },
          "alerts": {
            "type": "integer"
          },
          "txBytes": {
            "type": "integer",
            "format": "int64"
          },
          "snr": {
            "type": "integer"
          },
          "authMethod": {
            "type": "string"
          },
          "radioType": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "zoneVersion": {
            "type": "string"
          },
          "authStatus": {
            "type": "string"
          },
          "uplinkRate": {
            "type": "integer",
            "format": "int64"
          },
          "downlinkRate": {
            "type": "integer",
            "format": "int64"
          },
          "txRatebps": {
            "type": "integer"
          },
          "zoneId": {
            "type": "string"
          },
          "bssid": {
            "type": "string"
          },
          "tcWithQuotaList": {
            "type": "array",
            "items": {
              "additionalProperties": false,
              "type": "object",
              "properties": {
                "tcName": {
                  "type": "string"
                },
                "tcMaxQuota": {
                  "type": "string"
                },
                "tcRemainingQuota": {
                  "type": "string"
                }
              }
            }
          },
          "cpeMac": {
            "type": "string"
          },
          "medianTxMCSRate": {
            "type": "integer",
            "format": "int64"
          },
          "medianRxMCSRate": {
            "type": "integer",
            "format": "int64"
          }
        }
      }
    }
  }
}

Historical Client

POST/v11_1/query/historicalclient

Use this API command to retrive historical client. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": true,
  "firstIndex": 0,
  "extra": "",
  "list": [
    {
      "sessionStartTime": "1466496511",
      "sessionEndTime": "1466496666",
      "clientMac": "AA:8A:DE:24:FA:00",
      "ipAddress": "192.168.1.100",
      "coreNetworkType": "TTG",
      "mvnoId": "AT&T",
      "apMac": "C0:8A:DE:24:FA:00",
      "ssid": "TestSSID",
      "txBytes": "26431",
      "rxBytes": "52513525",
      "txFrames": "2656",
      "rxFrames": "154625",
      "txDrops": "659",
      "rxDrops": "125"
    }
  ]
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "totalCount": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for historical client",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "sessionStartTime": {
            "description": "Session start time of the client",
            "type": "integer",
            "format": "int64"
          },
          "sessionEndTime": {
            "description": "Session end time of the client",
            "type": "integer",
            "format": "int64"
          },
          "clientMac": {
            "description": "Client MAC address",
            "type": "string"
          },
          "ipAddress": {
            "description": "Client IP address",
            "type": "string"
          },
          "ipv6Address": {
            "description": "Client IPv6 address",
            "type": "string"
          },
          "coreNetworkType": {
            "description": "Core network type of the client",
            "type": "string"
          },
          "hostname": {
            "description": "Hostname of the client",
            "type": "string"
          },
          "osType": {
            "description": "OS type of the client",
            "type": "string"
          },
          "modelName": {
            "description": "Model Name of the client",
            "type": "string"
          },
          "mvnoName": {
            "description": "MVNO name of the client",
            "type": "string"
          },
          "apMac": {
            "description": "Client connected AP's MAC address",
            "type": "string"
          },
          "ssid": {
            "description": "Client connected SSID name",
            "type": "string"
          },
          "txBytes": {
            "description": "Bytes from client",
            "type": "integer",
            "format": "int64"
          },
          "rxBytes": {
            "description": "Bytes to client",
            "type": "integer",
            "format": "int64"
          },
          "txFrames": {
            "description": "Bytes from client",
            "type": "integer",
            "format": "int64"
          },
          "rxFrames": {
            "description": "Bytes to client",
            "type": "integer",
            "format": "int64"
          },
          "txDrops": {
            "description": "Dropped packets from client",
            "type": "integer"
          },
          "rxDrops": {
            "description": "Dropped packets to client",
            "type": "integer"
          }
        }
      }
    }
  }
}

Wired Client

Query Wired Clients

POST/v11_1/query/wiredclient

Query wired clients with specified filters Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "apMac": "58:B6:33:37:D4:E0",
      "apName": "R710_Box_Up_Pink",
      "apEthID": 2,
      "hostname": "Nolan_DELL_Laptop",
      "authStatus": "AUTHORIZED",
      "osType": "Windows 7/Vista",
      "deviceType": "Laptop",
      "osVendorType": "Windows",
      "modelName": "Windows 7/Vista",
      "ipAddress": "10.11.0.86",
      "ipv6Address": "2001:b030:2516:164:7074:3f14:f0d9:c939",
      "clientMac": "00:24:D7:89:36:A0",
      "txBytes": 2099158501,
      "rxBytes": 73731395,
      "txRxBytes": 2172889896,
      "uplink": 73731395,
      "downlink": 2099158501,
      "traffic": 2172889896,
      "vlan": 1,
      "userName": "Admin",
      "rxFrames": 952977,
      "txFrames": 1729632,
      "txRetry": 952977,
      "sessionStartTime": 1487400391000,
      "wlanType": null
    }
  ]
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "totalCount": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for client list",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "apName": {
            "type": "string"
          },
          "ipv6Address": {
            "type": "string"
          },
          "clientMac": {
            "type": "string"
          },
          "traffic": {
            "type": "integer",
            "format": "int64"
          },
          "uplink": {
            "type": "integer",
            "format": "int64"
          },
          "downlink": {
            "type": "integer",
            "format": "int64"
          },
          "txRxBytes": {
            "type": "integer",
            "format": "int64"
          },
          "txRetry": {
            "type": "integer"
          },
          "txFrames": {
            "type": "integer",
            "format": "int64"
          },
          "hostname": {
            "type": "string"
          },
          "vlan": {
            "type": "integer"
          },
          "rxFrames": {
            "type": "integer",
            "format": "int64"
          },
          "wlanType": {
            "type": "string"
          },
          "osType": {
            "type": "string"
          },
          "deviceType": {
            "type": "string"
          },
          "osVendorType": {
            "type": "string"
          },
          "modelName": {
            "type": "string"
          },
          "rxBytes": {
            "type": "integer",
            "format": "int64"
          },
          "ipAddress": {
            "type": "string"
          },
          "sessionStartTime": {
            "type": "integer",
            "format": "int64"
          },
          "apMac": {
            "type": "string"
          },
          "userName": {
            "type": "string"
          },
          "userRoleId": {
            "type": "string"
          },
          "userRoleName": {
            "type": "string"
          },
          "txBytes": {
            "type": "integer",
            "format": "int64"
          },
          "authStatus": {
            "type": "string"
          },
          "apEthID": {
            "type": "integer"
          },
          "vni": {
            "type": "integer"
          }
        }
      }
    }
  }
}

Deauth Wired Client

POST/v11_1/wiredClients/deauth

Use this API command to deauth client.

Request
HideShow
Body
{
  "mac": "E8:99:C4:AD:7C:38",
  "apMac": "C0:8A:DE:24:FA:00"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "mac": {
      "description": "Client Mac",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
    },
    "apMac": {
      "description": "AP Mac",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
    }
  },
  "required": [
    "mac",
    "apMac"
  ]
}
Response  204

Bulk Deauth Wired Client

POST/v11_1/wiredClients/bulkDeauth

Use this API command to bulk deauth client.

Request
HideShow
Body
{
  "clientList": [
    {
      "apMac": "AB:CD:00:00:00:0E",
      "mac": "20:80:00:00:1F:40"
    },
    {
      "apMac": "AB:CD:00:00:00:0D",
      "mac": "20:90:00:00:23:28"
    }
  ]
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "clientList": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "mac": {
            "description": "Client Mac",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "apMac": {
            "description": "AP Mac",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          }
        },
        "required": [
          "mac",
          "apMac"
        ]
      },
      "minItems": 1,
      "uniqueItems": true
    }
  }
}
Response  204

Block Client

Retrieve

GET/v11_1/blockClient/{id}

Retrieve a Block Client.

Response  200
HideShow
Body
{
  "mac": "AA:BB:CC:DD:EE:FF",
  "description": ""
}
Schema
{
  "type": "object",
  "properties": {
    "mac": {
      "description": "MAC of the Block Client",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
    },
    "zoneId": {
      "description": "Zone Id of the Block Client for clone in System Domain",
      "type": "string"
    },
    "description": {
      "description": "Description of the Block Client",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer",
      "format": "int64"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  },
  "required": [
    "mac"
  ]
}

Retrieve List

GET/v11_1/blockClient/byZone/{zoneId}

Retrieve a list of Block Client.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "3cc54201-6523-11e6-ab64-24c9a13f96c1",
      "mac": "AA:BB:CC:DD:EE:FF",
      "description": "des",
      "modifiedDateTime": 1471511269921,
      "modifierUsername": "admin"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the profile",
            "type": "string"
          },
          "mac": {
            "description": "MAC of the Block Client",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "zoneId": {
            "description": "Zone Id of the Block Client for clone in System Domain",
            "type": "string"
          },
          "description": {
            "description": "Description of the Block Client",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "modifiedDateTime": {
            "description": "Date blocked of the Block Client",
            "type": "integer",
            "format": "int64"
          },
          "modifierUsername": {
            "description": "Modifier blocked of the Block Client",
            "type": "string"
          }
        }
      }
    }
  }
}

Create Block Client by Zone ID

POST/v11_1/blockClient/byZoneId/{zoneId}

Create a new Block Client by Zone ID

Request
HideShow
Body
{
  "mac": "AA:BB:CC:DD:EE:FF",
  "description": ""
}
Schema
{
  "type": "object",
  "properties": {
    "mac": {
      "description": "MAC of the Block Client",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
    },
    "zoneId": {
      "description": "Zone Id of the Block Client for clone in System Domain",
      "type": "string"
    },
    "description": {
      "description": "Description of the Block Client",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer",
      "format": "int64"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  },
  "required": [
    "mac"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create Block Client by AP MAC

POST/v11_1/blockClient/byApMac/{apMac}

Create a new Block Client by AP MAC.

Request
HideShow
Body
{
  "mac": "AA:BB:CC:DD:EE:FF",
  "description": ""
}
Schema
{
  "type": "object",
  "properties": {
    "mac": {
      "description": "MAC of the Block Client",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
    },
    "zoneId": {
      "description": "Zone Id of the Block Client for clone in System Domain",
      "type": "string"
    },
    "description": {
      "description": "Description of the Block Client",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer",
      "format": "int64"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  },
  "required": [
    "mac"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create Block Clients

POST/v11_1/blockClient

Create new Block Clients by list.

Request
HideShow
Body
{
  "blockClientList": [
    {
      "mac": "27:60:00:01:28:E0",
      "apMac": "AB:CD:00:00:00:14"
    },
    {
      "mac": "27:70:00:01:2C:C8",
      "apMac": "AB:CD:00:00:00:13"
    }
  ],
  "description": ""
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "blockClientList": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "mac": {
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "zoneId": {
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "apMac": {
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          }
        },
        "required": [
          "mac",
          "apMac"
        ]
      }
    },
    "description": {
      "description": "Description of the Block Client",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    }
  }
}
Response  201
HideShow
Body
[
  {
    "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
  }
]
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "id": {
        "type": "string"
      }
    }
  }
}

Retrieve List

POST/v11_1/blockClient/query

Retrieve a list of Block Client. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "3cc54201-6523-11e6-ab64-24c9a13f96c1",
      "mac": "AA:BB:CC:DD:EE:FF",
      "description": "des",
      "modifiedDateTime": 1471511269921,
      "modifierUsername": "admin"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the profile",
            "type": "string"
          },
          "mac": {
            "description": "MAC of the Block Client",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "zoneId": {
            "description": "Zone Id of the Block Client for clone in System Domain",
            "type": "string"
          },
          "description": {
            "description": "Description of the Block Client",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "modifiedDateTime": {
            "description": "Date blocked of the Block Client",
            "type": "integer",
            "format": "int64"
          },
          "modifierUsername": {
            "description": "Modifier blocked of the Block Client",
            "type": "string"
          }
        }
      }
    }
  }
}

Modify

PUT/v11_1/blockClient/{id}

Modify a specific Block Client basic.

Request
HideShow
Body
{
  "mac": "AA:BB:CC:DD:EE:FF",
  "description": "des"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "mac": {
      "description": "MAC of the Block Client",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
    },
    "description": {
      "description": "Description of the Block Client",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    }
  }
}
Response  204

Modify

PATCH/v11_1/blockClient/{id}

Modify a specific Block Client basic.

Request
HideShow
Body
{
  "mac": "AA:BB:CC:DD:EE:FF",
  "description": "des"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "mac": {
      "description": "MAC of the Block Client",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
    },
    "description": {
      "description": "Description of the Block Client",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    }
  }
}
Response  204

Delete

DELETE/v11_1/blockClient/{id}

Delete a Block Client.

Response  204

Delete

DELETE/v11_1/blockClient

Delete Block Client List.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

LWAPP TO SCG

Get Lwapp Config

GET/v11_1/lwapp2scg

Use this API command to retrieve Lwapp Config.

Response  200
HideShow
Body
{
  "policy": "DENY_ALL",
  "pasvMaxPort": null,
  "pasvMinPort": null,
  "acl": "null",
  "apList": [],
  "natIpTranslation": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "policy": {
      "description": "policy of the lwapp",
      "type": "string",
      "enum": [
        "DENY",
        "ACCEPT",
        "DENY_ALL",
        "ACCEPT_ALL"
      ]
    },
    "pasvMaxPort": {
      "description": "pasvMaxPort of the lwapp",
      "type": "integer",
      "minimum": 16384,
      "maximum": 65000
    },
    "pasvMinPort": {
      "description": "pasvMinPort of the lwapp",
      "type": "integer",
      "minimum": 16384,
      "maximum": 65000
    },
    "apList": {
      "description": "accessPoint List  of the lwapp",
      "type": "array",
      "items": {
        "description": "AP MAC Address or AP Serial Number",
        "type": "string"
      }
    },
    "acl": {
      "description": "acl  of the lwapp",
      "type": "string"
    },
    "natIpTranslation": {
      "description": "natIpTranslation of the lwapp",
      "type": "boolean"
    }
  }
}

Modify

PATCH/v11_1/lwapp2scg

Use this API command to modify the basic information of the Lwapp Config.

Request
HideShow
Body
{
  "policy": "ACCEPT",
  "pasvMaxPort": 65000,
  "pasvMinPort": 16384,
  "apList": [
    "12345",
    "00:1D:2E:45:10:00"
  ],
  "natIpTranslation": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "policy": {
      "description": "policy of the lwapp",
      "type": "string",
      "enum": [
        "DENY",
        "ACCEPT",
        "DENY_ALL",
        "ACCEPT_ALL"
      ]
    },
    "pasvMaxPort": {
      "description": "pasvMaxPort of the lwapp",
      "type": "integer",
      "minimum": 16384,
      "maximum": 65000
    },
    "pasvMinPort": {
      "description": "pasvMinPort of the lwapp",
      "type": "integer",
      "minimum": 16384,
      "maximum": 65000
    },
    "apList": {
      "description": "accessPoint List  of the lwapp",
      "type": "array",
      "items": {
        "description": "AP MAC Address or AP Serial Number",
        "type": "string"
      }
    },
    "natIpTranslation": {
      "description": "natIpTranslation of the lwapp",
      "type": "boolean"
    }
  }
}
Response  204

Modify ApList

PATCH/v11_1/lwapp2scg/apList

Use this API command to modify the apList of the Lwapp Config.

Request
HideShow
Body
[
  "12345",
  "00:1D:2E:45:10:00"
]
Schema
{
  "description": "accessPoint List  of the lwapp",
  "type": "array",
  "items": {
    "description": "AP MAC Address or AP Serial Number",
    "type": "string"
  }
}
Response  204

Rogue Client

Query Rogue Client List

POST/v11_1/rogueclients/query

Use this API command to retrieve a list of rogue clients. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "rawDataTotalCount": 100,
  "totalCount": 10,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "detectedByAP": [
        {
          "apMac": "FF:FF:FF:FF:FF:FF",
          "apName": "Dummy AP",
          "rssi": "64",
          "rogueType": "Rogue",
          "lastDetected": 1470717826622,
          "zoneName": "Zone1",
          "mainDetector": true
        }
      ],
      "channel": 11,
      "rogueMac": "DD:DD:DD:DD:DD:DD",
      "encryption": "WPA",
      "radio": "54",
      "lastDetected": 1470717826622,
      "ssid": "Dummy SSID",
      "type": "AD_HOC",
      "rogueAPMac": "EE:EE:EE:EE:EE:EE"
    },
    {
      "detectedByAP": [
        {
          "apMac": "FF:FF:FF:FF:FF:FF",
          "apName": "Dummy AP",
          "rssi": "64",
          "lastDetected": 1470717826622
        }
      ],
      "channel": 11,
      "rogueMac": "DD:DD:DD:DD:DD:DD",
      "encryption": "WPA",
      "radio": "54",
      "lastDetected": 1470717826622,
      "ssid": "Dummy SSID",
      "type": "AD_HOC",
      "rogueAPMac": "EE:EE:EE:EE:EE:EE"
    }
  ],
  "extra": null
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "rawDataTotalCount" : {
            "description" : "Total Rogue Clients count.",
            "type" : "integer"
        },
        "totalCount" : {
            "description" : "Total Rogue Clients count in this response.",
            "type" : "integer"
        },
        "extra" : {
            "description" : "Any additional response data.",
            "type" : "object"
        },
        "hasMore" : {
            "description" : "Indicator of whether there are more Rogue Clients after the current displayed list",
            "type" : "boolean"
        },
        "firstIndex" : {
            "description" : "Index of the first Rogue AP returned out of the complete Rogue Client list",
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "detectedByAP" : {
                        "description" : "The list of APs that found the rogue client",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "apMac" : {
                                    "description" : "AP MAC of the rogue AP",
                                    "type" : "string",
                                    "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                                },
                                "apName" : {
                                    "description" : "Name of the rogue AP",
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 64,
                                    "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
                                },
                                "rssi" : {
                                    "description" : "RSSI of the rogue AP",
                                    "type" : "string"
                                },
                                "lastDetected" : {
                                    "description" : "Timestamp of the AP",
                                    "type" : "integer"
                                },
                                "zoneName" : {
                                    "description" : "Zone name",
                                    "type" : "string"
                                },
                                "rogueType" : {
                                    "description" : "Rogue type",
                                    "type" : "string"
                                },
                                "mainDetector" : {
                                    "description" : "To identify whether this is main instance for UI",
                                    "type" : "boolean"
                                }
                            }
                        }
                    },
                    "channel" : {
                        "description" : "Channel of the rogue client",
                        "type" : "integer"
                    },
                    "rogueMac" : {
                        "description" : "Mac of the rogue client",
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                    },
                    "encryption" : {
                        "description" : "Encryption of the rogue client",
                        "type" : "string"
                    },
                    "radio" : {
                        "description" : "Radio of the rogue client",
                        "type" : "string"
                    },
                    "lastDetected" : {
                        "description" : "Timestamp of the rogue client",
                        "type" : "integer",
                        "format" : "int64"
                    },
                    "ssid" : {
                        "description" : "SSID of the rogue client",
                        "type" : "string"
                    },
                    "type" : {
                        "description" : "Type of the rogue client",
                        "type" : "string"
                    },
                    "rogueAPMac" : {
                        "description" : "AP Mac of the rogue client",
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                    },
                    "classification" : {
                        "description" : "Rogue classification by policy",
                        "type" : "string"
                    },
                    "matchResult" : {
                        "description" : "What policy and rule matched when system doing classification by rogue policy",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

Rogue Classification Policy

Retrieve rogue AP policy.

GET/v11_1/rkszones/{zoneId}/rogueApPolicies/{id}

Use this API command to retrieve rogue AP policy.

Response  200
HideShow
Body
{
  "id": "ddedfc70-6b95-11e7-98f9-0a0027000000",
  "name": "Rogue AP Policy",
  "description": "Description",
  "defaultPolicy": false,
  "active": false,
  "rules": [
    {
      "type": "MacSpoofingRule",
      "name": "MAC Spoofing Rule",
      "priority": 2,
      "value": "mac-spoof",
      "classification": "Malicious",
      "plainTypeString": "Malicious AP (MAC-spoof)"
    },
    {
      "type": "SameNetworkRule",
      "name": "Same Network Rule",
      "priority": 1,
      "value": "same-network",
      "classification": "Malicious",
      "plainTypeString": "Malicious AP (Same-Network)"
    }
  ],
  "applyToResourceId": "",
  "applyToResourceType": "None",
  "zoneId": "b7b87594-ef45-4591-85e0-f344f8a3fe7c",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "modifiedDateTime": 1484720657237,
  "modifierUsername": "Admin"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "rules": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
          },
          "type": {
            "type": "string",
            "enum": [
              "AdhocRule",
              "SsidSpoofingRule",
              "MacSpoofingRule",
              "SameNetworkRule",
              "CTSAbuseRule",
              "RTSAbuseRule",
              "DeauthFloodRule",
              "DisassocFloodRule",
              "ExcessivePowerRule",
              "NullSSIDRule",
              "CustomSsidRule",
              "CustomRssiRule",
              "CustomMacOuiRule",
              "FloodAuthRule",
              "FloodEapRule"
            ]
          },
          "value": {
            "type": "string"
          },
          "priority": {
            "type": "integer"
          },
          "classification": {
            "type": "string",
            "enum": [
              "Ignore",
              "Known",
              "Rogue",
              "Malicious"
            ]
          }
        },
        "required": [
          "name",
          "type",
          "priority",
          "classification"
        ]
      }
    },
    "zoneId": {
      "type": "string"
    },
    "modifiedDateTime": {
      "type": "integer"
    },
    "modifierUsername": {
      "type": "string"
    },
    "createDateTime": {
      "type": "integer"
    },
    "creatorId": {
      "type": "string"
    },
    "modifierId": {
      "type": "string"
    },
    "creatorUsername": {
      "type": "string"
    }
  }
}

Retrieve a list of rogue AP policy.

GET/v11_1/rkszones/{zoneId}/rogueApPolicies

Use this API command to retrieve a list of rogue AP policy.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "name": "Default Policy",
  "description": "This is description",
  "modifierUsername": "User name",
  "modifiedDateTime": "1499329195189",
  "list": [
    {
      "id": "94b903e1-6223-11e7-9bbb-0a0027000000",
      "rules": [
        {
          "type": "AdhocRule",
          "name": "Ad Hoc Rule",
          "priority": 4,
          "value": "ad-hoc",
          "classification": "Rogue"
        },
        {
          "type": "SsidSpoofingRule",
          "name": "SSID Spoofing Rule",
          "priority": 3,
          "value": "ssid-spoof",
          "classification": "Malicious"
        },
        {
          "type": "MacSpoofingRule",
          "name": "MAC Spoofing Rule",
          "priority": 2,
          "value": "mac-spoof",
          "classification": "Malicious"
        },
        {
          "type": "CustomMacOuiRule",
          "name": "Rule name",
          "priority": 1,
          "value": "22:33:44",
          "classification": "Malicious"
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "rules": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "name": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 64,
                  "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "AdhocRule",
                    "SsidSpoofingRule",
                    "MacSpoofingRule",
                    "SameNetworkRule",
                    "CTSAbuseRule",
                    "RTSAbuseRule",
                    "DeauthFloodRule",
                    "DisassocFloodRule",
                    "ExcessivePowerRule",
                    "NullSSIDRule",
                    "CustomSsidRule",
                    "CustomRssiRule",
                    "CustomMacOuiRule",
                    "FloodAuthRule",
                    "FloodEapRule"
                  ]
                },
                "value": {
                  "type": "string"
                },
                "priority": {
                  "type": "integer"
                },
                "classification": {
                  "type": "string",
                  "enum": [
                    "Ignore",
                    "Known",
                    "Rogue",
                    "Malicious"
                  ]
                }
              },
              "required": [
                "name",
                "type",
                "priority",
                "classification"
              ]
            }
          },
          "zoneId": {
            "type": "string"
          },
          "modifiedDateTime": {
            "type": "integer"
          },
          "modifierUsername": {
            "type": "string"
          },
          "createDateTime": {
            "type": "integer"
          },
          "creatorId": {
            "type": "string"
          },
          "modifierId": {
            "type": "string"
          },
          "creatorUsername": {
            "type": "string"
          }
        }
      }
    }
  }
}

Create rogue AP policy.

POST/v11_1/rkszones/{zoneId}/rogueApPolicies

Use this API command to create rogue AP policy.

Request
HideShow
Body
{
  "name": "Rogue AP Policy",
  "description": "Description",
  "rules": [
    {
      "name": "Rule name",
      "type": "CustomMacOuiRule",
      "value": "11:22:33",
      "classification": "Malicious",
      "priority": 1
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "rules": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
          },
          "type": {
            "type": "string",
            "enum": [
              "AdhocRule",
              "SsidSpoofingRule",
              "MacSpoofingRule",
              "SameNetworkRule",
              "CTSAbuseRule",
              "RTSAbuseRule",
              "DeauthFloodRule",
              "DisassocFloodRule",
              "ExcessivePowerRule",
              "NullSSIDRule",
              "CustomSsidRule",
              "CustomRssiRule",
              "CustomMacOuiRule",
              "FloodAuthRule",
              "FloodEapRule"
            ]
          },
          "value": {
            "type": "string"
          },
          "priority": {
            "type": "integer"
          },
          "classification": {
            "type": "string",
            "enum": [
              "Ignore",
              "Known",
              "Rogue",
              "Malicious"
            ]
          }
        },
        "required": [
          "name",
          "type",
          "priority",
          "classification"
        ]
      }
    }
  },
  "required": [
    "name",
    "rules"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify rogue AP policy.

PATCH/v11_1/rkszones/{zoneId}/rogueApPolicies/{id}

Use this API command to modify rogue AP policy.

Request
HideShow
Body
{
  "name": "Update Rogue AP Policy",
  "description": "This is description",
  "rules": [
    {
      "type": "CustomMacOuiRule",
      "name": "New rule",
      "priority": 1,
      "value": "22:33:44",
      "classification": "Malicious"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "rules": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64,
            "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
          },
          "type": {
            "type": "string",
            "enum": [
              "AdhocRule",
              "SsidSpoofingRule",
              "MacSpoofingRule",
              "SameNetworkRule",
              "CTSAbuseRule",
              "RTSAbuseRule",
              "DeauthFloodRule",
              "DisassocFloodRule",
              "ExcessivePowerRule",
              "NullSSIDRule",
              "CustomSsidRule",
              "CustomRssiRule",
              "CustomMacOuiRule",
              "FloodAuthRule",
              "FloodEapRule"
            ]
          },
          "value": {
            "type": "string"
          },
          "priority": {
            "type": "integer"
          },
          "classification": {
            "type": "string",
            "enum": [
              "Ignore",
              "Known",
              "Rogue",
              "Malicious"
            ]
          }
        },
        "required": [
          "name",
          "type",
          "priority",
          "classification"
        ]
      }
    }
  }
}
Response  204

Delete rogue AP policy.

DELETE/v11_1/rkszones/{zoneId}/rogueApPolicies/{id}

Use this API command to delete rogue AP policy.

Response  200

Delete bulk rogue AP policy.

DELETE/v11_1/rkszones/{zoneId}/rogueApPolicies

Use this API command to delete bulk rogue AP policy.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Mark Rogue

Get known Rogue

GET/v11_1/rogue/markKnown

Get Known Rogue AP list.

Response  200
HideShow
Body
{
  "rogueMacList": [
    "E0:11:12:23:F2:22"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "rogueMacList": {
      "type": "array",
      "description": "rogue mac list",
      "items": {
        "type": "string",
        "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
      }
    }
  }
}

Unmark Rogue

POST/v11_1/rogue/unMark

Use this API command to remove the manual admin classification marking.

Request
HideShow
Body
{
  "rogueMacList": [
    "E0:11:12:23:F2:22"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "rogueMacList": {
      "type": "array",
      "description": "rogue mac list",
      "items": {
        "type": "string",
        "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
      }
    }
  }
}
Response  204

Mark Known Rogue

POST/v11_1/rogue/markKnown

Mark a rogue AP as know.

Request
HideShow
Body
{
  "rogueMacList": [
    "E0:11:12:23:F2:22"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "rogueMacList": {
      "type": "array",
      "description": "rogue mac list",
      "items": {
        "type": "string",
        "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
      }
    }
  }
}
Response  204

Mark Malicious Rogue

POST/v11_1/rogue/markMalicious

Mark a rogue AP as malicious.

Request
HideShow
Body
{
  "rogueMacList": [
    "E0:11:12:23:F2:22"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "rogueMacList": {
      "type": "array",
      "description": "rogue mac list",
      "items": {
        "type": "string",
        "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
      }
    }
  }
}
Response  204

Mark Ignore Rogue

POST/v11_1/rogue/markIgnore

Mark a rogue AP as ignore.

Request
HideShow
Body
{
  "rogueMacList": [
    "E0:11:12:23:F2:22"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "rogueMacList": {
      "type": "array",
      "description": "rogue mac list",
      "items": {
        "type": "string",
        "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
      }
    }
  }
}
Response  204

Mark Rogue to Rogue

POST/v11_1/rogue/markRogue

Mark a rogue AP as rogue.

Request
HideShow
Body
{
  "rogueMacList": [
    "E0:11:12:23:F2:22"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "rogueMacList": {
      "type": "array",
      "description": "rogue mac list",
      "items": {
        "type": "string",
        "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
      }
    }
  }
}
Response  204

Dynamic PSK

Retrieve DPSK info By Zone

GET/v11_1/rkszones/{zoneId}/dpsk

Use this API command to retrieve DPSK info of a zone.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "caa96db0-5c62-4559-8c38-669f31943ca8",
      "wlanId": "3",
      "userName": "BatchDPSK_User_0",
      "macAddress": null,
      "passphrase": "zheO}VO2",
      "userRoleId": null,
      "vlanId": null,
      "groupDpsk": false,
      "creationDateTime": "2015/12/11 17:59:04",
      "expirationDateTime": "2 days from first use"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "description": "Information list of DPSK",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of DPSK",
            "type": "string"
          },
          "wlanId": {
            "description": "WLAN ID of DPSK",
            "type": "string"
          },
          "userName": {
            "description": "User Name of DPSK",
            "type": "string"
          },
          "macAddress": {
            "description": "Mac address of DPSK",
            "type": "string"
          },
          "passphrase": {
            "description": "Passphrase of DPSK",
            "type": "string"
          },
          "userRoleId": {
            "description": "Identity User Role ID of DPSK",
            "type": "string"
          },
          "vlanId": {
            "description": "VLAN ID of DPSK",
            "type": "integer"
          },
          "groupDpsk": {
            "description": "Is a Group DPSK or not",
            "type": "boolean"
          },
          "creationDateTime": {
            "description": "Creationd date/time of DPSK",
            "type": "number"
          },
          "expirationDateTime": {
            "description": "Expiration date/time of DPSK",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve DPSK info By WLAN

GET/v11_1/rkszones/{zoneId}/wlans/{id}/dpsk

Use this API command to retrieve DPSK info of a WLAN.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "caa96db0-5c62-4559-8c38-669f31943ca8",
      "wlanId": "3",
      "userName": "BatchDPSK_User_0",
      "macAddress": null,
      "passphrase": "zheO}VO2",
      "userRoleId": null,
      "vlanId": null,
      "groupDpsk": false,
      "creationDateTime": "2015/12/11 17:59:04",
      "expirationDateTime": "2 days from first use"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "description": "Information list of DPSK",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of DPSK",
            "type": "string"
          },
          "wlanId": {
            "description": "WLAN ID of DPSK",
            "type": "string"
          },
          "userName": {
            "description": "User Name of DPSK",
            "type": "string"
          },
          "macAddress": {
            "description": "Mac address of DPSK",
            "type": "string"
          },
          "passphrase": {
            "description": "Passphrase of DPSK",
            "type": "string"
          },
          "userRoleId": {
            "description": "Identity User Role ID of DPSK",
            "type": "string"
          },
          "vlanId": {
            "description": "VLAN ID of DPSK",
            "type": "integer"
          },
          "groupDpsk": {
            "description": "Is a Group DPSK or not",
            "type": "boolean"
          },
          "creationDateTime": {
            "description": "Creationd date/time of DPSK",
            "type": "number"
          },
          "expirationDateTime": {
            "description": "Expiration date/time of DPSK",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve DPSK info By Id

GET/v11_1/rkszones/{zoneId}/wlans/{id}/dpsk/{dpskId}

Use this API command to retrieve DPSK info.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "caa96db0-5c62-4559-8c38-669f31943ca8",
      "wlanId": "3",
      "userName": "BatchDPSK_User_0",
      "macAddress": null,
      "passphrase": "zheO}VO2",
      "userRoleId": null,
      "vlanId": null,
      "groupDpsk": false,
      "creationDateTime": "2015/12/11 17:59:04",
      "expirationDateTime": "2 days from first use"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "description": "Information list of DPSK",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of DPSK",
            "type": "string"
          },
          "wlanId": {
            "description": "WLAN ID of DPSK",
            "type": "string"
          },
          "userName": {
            "description": "User Name of DPSK",
            "type": "string"
          },
          "macAddress": {
            "description": "Mac address of DPSK",
            "type": "string"
          },
          "passphrase": {
            "description": "Passphrase of DPSK",
            "type": "string"
          },
          "userRoleId": {
            "description": "Identity User Role ID of DPSK",
            "type": "string"
          },
          "vlanId": {
            "description": "VLAN ID of DPSK",
            "type": "integer"
          },
          "groupDpsk": {
            "description": "Is a Group DPSK or not",
            "type": "boolean"
          },
          "creationDateTime": {
            "description": "Creationd date/time of DPSK",
            "type": "number"
          },
          "expirationDateTime": {
            "description": "Expiration date/time of DPSK",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve interval of delete expired DPSK

GET/v11_1/rkszones/{zoneId}/deleteExpiredDpsk

Use this API command to retrieve interval of delete expired DPSK of a zone.

Response  200
HideShow
Body
{
  "deleteExpiredDpsk": "Never"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "deleteExpiredDpsk": {
      "description": "Delete expired DPSK interval of the Zone.",
      "type": "string",
      "enum": [
        "Never",
        "AfterOneDay",
        "AfterSixMonths"
      ]
    }
  }
}

Retrieve DPSK Enabled WLAN info By Zone.

GET/v11_1/rkszones/{zoneId}/dpskEnabledWlans

Use this API command to retrieve DPSK enabled WLAN info of a zone.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "wlanId": "1",
      "ssid": "ssid1",
      "wlanName": "DpskWlan1"
    },
    {
      "wlanId": "2",
      "ssid": "ssid2",
      "wlanName": "DpskWlan2"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total DPSK enabled WLAN count of the zone",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more DPSK enabled WLANs after the list that is currently displayed",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first DPSK enabled WLAN returned out of the complete WLAN list",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "wlanId": {
            "description": "Identifier of the DPSK enabled WLAN",
            "type": "string"
          },
          "ssid": {
            "description": "SSID of the DPSK enabled WLAN",
            "type": "string"
          },
          "wlanName": {
            "description": "Name of the the DPSK enabled WLAN",
            "type": "string"
          }
        }
      }
    }
  }
}

Download DPSK CSV sample

GET/v11_1/rkszones/downloadDpskCsvSample

Use this API command to download DPSK CSV sample.

URI Parameters
HideShow
type
string (optional) 

DPSK CSV sample type. Valid value is PHASE1 or PHASE2. Default: PHASE2.

Response  200
HideShow
Headers
Content-Type: application/octet-stream

Upload DPSK file

POST/v11_1/rkszones/{zoneId}/wlans/{id}/dpsk/upload

Use this API command to upload DPSK file of a WLAN (CSV file and Content-Type multipart/form-data ONLY).

Request
HideShow
Headers
Content-Type: multipart/form-data
Response  201
HideShow
Body
{
  "resultCount": 2,
  "dpskInfoList": [
    {
      "id": "5da5b9e9-78de-46f5-8d73-b0b7ac8abd37",
      "wlanId": "1",
      "userName": "student_0",
      "macAddress": null,
      "passphrase": "passphrase01",
      "userRoleId": "2759b0b3-0a40-455d-a061-e43072c334e5",
      "vlanId": 3,
      "groupDpsk": true,
      "creationDateTime": "2015/12/11 17:59:04",
      "expirationDateTime": "2 days from first use"
    },
    {
      "id": "6af7ec03-d853-4485-88e2-48d503c836b4",
      "wlanId": "1",
      "userName": "student_1",
      "macAddress": null,
      "passphrase": "passphrase02",
      "userRoleId": "2759b0b3-0a40-455d-a061-e43072c334e5",
      "vlanId": 3,
      "groupDpsk": true,
      "creationDateTime": "2015/12/11 17:59:04",
      "expirationDateTime": "2 days from first use"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "resultCount": {
      "type": "integer"
    },
    "dpskInfoList": {
      "description": "Information list of DPSK",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of DPSK",
            "type": "string"
          },
          "wlanId": {
            "description": "WLAN ID of DPSK",
            "type": "string"
          },
          "userName": {
            "description": "User Name of DPSK",
            "type": "string"
          },
          "macAddress": {
            "description": "Mac address of DPSK",
            "type": "string"
          },
          "passphrase": {
            "description": "Passphrase of DPSK",
            "type": "string"
          },
          "userRoleId": {
            "description": "Identity User Role ID of DPSK",
            "type": "string"
          },
          "vlanId": {
            "description": "VLAN ID of DPSK",
            "type": "integer"
          },
          "groupDpsk": {
            "description": "Is a Group DPSK or not",
            "type": "boolean"
          },
          "creationDateTime": {
            "description": "Creationd date/time of DPSK",
            "type": "number"
          },
          "expirationDateTime": {
            "description": "Expiration date/time of DPSK",
            "type": "string"
          }
        }
      }
    }
  }
}

Batch Generate DPSKs

POST/v11_1/rkszones/{zoneId}/wlans/{id}/dpsk/batchGenUnbound

Use this API command to batch generate DPSKs of a WLAN. You can either specify passphrases or not. If the amount is bigger than 1, system will generate usernames with index. e.g. student-1, student-2, …etc.

Request
HideShow
Body
‧ Sample : Batch generate DPSK with randomly passphrase(s)
{
    "amount" : 2,
    "userName" : "student",
    "userRoleId" : "2759b0b3-0a40-455d-a061-e43072c334e5",
    "vlanId" : 3,
    "groupDpsk" : true
}
‧ Sample : Batch generate DPSK with specified passphrase(s)
{
    "userName" : "student",
    "passphraseList" : [ "passphrase01", "passphrase02" ],
    "userRoleId" : "2759b0b3-0a40-455d-a061-e43072c334e5",
    "vlanId" : 3,
    "groupDpsk" : true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "amount" : {
            "description" : "Amount of generate unbound DPSK",
            "type" : "integer"
        },
        "userName" : {
            "description" : "User Name of DPSK",
            "type" : "string"
        },
        "passphraseList" : {
            "type" : "array",
            "items" : {
                "description" : "Generate DPSK with specific passphrase list",
                "type" : "string"
            }
        },
        "userRoleId" : {
            "description" : "Identity User Role ID of DPSK",
            "type" : "string"
        },
        "vlanId" : {
            "description" : "VLAN ID of DPSK",
            "type" : "integer"
        },
        "groupDpsk" : {
            "description" : "Using group DPSK or not",
            "type" : "boolean"
        }
    }
}
Response  201
HideShow
Body
{
  "resultCount": 2,
  "dpskInfoList": [
    {
      "id": "5da5b9e9-78de-46f5-8d73-b0b7ac8abd37",
      "wlanId": "1",
      "userName": "student_0",
      "macAddress": null,
      "passphrase": "passphrase01",
      "userRoleId": "2759b0b3-0a40-455d-a061-e43072c334e5",
      "vlanId": 3,
      "groupDpsk": true,
      "creationDateTime": "2015/12/11 17:59:04",
      "expirationDateTime": "2 days from first use"
    },
    {
      "id": "6af7ec03-d853-4485-88e2-48d503c836b4",
      "wlanId": "1",
      "userName": "student_1",
      "macAddress": null,
      "passphrase": "passphrase02",
      "userRoleId": "2759b0b3-0a40-455d-a061-e43072c334e5",
      "vlanId": 3,
      "groupDpsk": true,
      "creationDateTime": "2015/12/11 17:59:04",
      "expirationDateTime": "2 days from first use"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "resultCount": {
      "type": "integer"
    },
    "dpskInfoList": {
      "description": "Information list of DPSK",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of DPSK",
            "type": "string"
          },
          "wlanId": {
            "description": "WLAN ID of DPSK",
            "type": "string"
          },
          "userName": {
            "description": "User Name of DPSK",
            "type": "string"
          },
          "macAddress": {
            "description": "Mac address of DPSK",
            "type": "string"
          },
          "passphrase": {
            "description": "Passphrase of DPSK",
            "type": "string"
          },
          "userRoleId": {
            "description": "Identity User Role ID of DPSK",
            "type": "string"
          },
          "vlanId": {
            "description": "VLAN ID of DPSK",
            "type": "integer"
          },
          "groupDpsk": {
            "description": "Is a Group DPSK or not",
            "type": "boolean"
          },
          "creationDateTime": {
            "description": "Creationd date/time of DPSK",
            "type": "number"
          },
          "expirationDateTime": {
            "description": "Expiration date/time of DPSK",
            "type": "string"
          }
        }
      }
    }
  }
}

Delete DPSK

POST/v11_1/rkszones/{zoneId}/wlans/{id}/dpsk

Use this API command to delete DPSKs of a WLAN.

Request
HideShow
Body
{
  "idList": [
    "fb357b53-48dd-4a23-b6bf-2e3d935d8df3",
    "c2074deb-0f0c-47fa-bf56-f3f2f5b64de0"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "description": "Id list of DPSK",
        "type": "string"
      }
    }
  }
}
Response  200
HideShow
Body
{
  "resultCount": 2
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "resultCount": {
      "type": "integer"
    }
  }
}

Query DPSKs

POST/v11_1/query/dpsk

Query DPSKs with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "extra": {
    "rbacMetadata": [
      {
        "DEVICE_CATEGORY": "FULL_ACCESS"
      }
    ]
  },
  "list": [
    {
      "key": "caa96db0-5c62-4559-8c38-669f31943ca8",
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "zoneId": "6a61585a-2631-4086-b6cc-793470c419a1",
      "wlanId": "3",
      "userName": "BatchDPSK_User_0",
      "ueMac": null,
      "userRoleId": null,
      "vlanId": null,
      "group": false,
      "expired": true,
      "ttl": 172800,
      "expirationStartTime": 1468921101,
      "expirationTime": 1469093901,
      "creationDateTime": 1469007501404
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for DPSK list",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "description": "Information list of DPSK",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "key": {
            "description": "Identifier of DPSK",
            "type": "string"
          },
          "tenantId": {
            "description": "Tenant ID of DPSK",
            "type": "string"
          },
          "domainId": {
            "description": "Domain ID of DPSK",
            "type": "string"
          },
          "zoneId": {
            "description": "Zone ID of DPSK",
            "type": "string"
          },
          "wlanId": {
            "description": "WLAN ID of DPSK",
            "type": "string"
          },
          "userName": {
            "description": "User Name of DPSK",
            "type": "string"
          },
          "ueMac": {
            "description": "Mac address of DPSK",
            "type": "string"
          },
          "userRoleId": {
            "description": "Identity User Role ID of DPSK",
            "type": "string"
          },
          "vlanId": {
            "description": "VLAN ID of DPSK",
            "type": "integer"
          },
          "group": {
            "description": "Is a Group DPSK or not",
            "type": "boolean"
          },
          "expired": {
            "description": "DPSK is expired or not",
            "type": "boolean"
          },
          "ttl": {
            "description": "Time To Live of DPSK (Unit: Seconds)",
            "type": "number"
          },
          "expirationStartTime": {
            "description": "Expiration start time of DPSK (Unit: Seconds)",
            "type": "number"
          },
          "expirationTime": {
            "description": "Expiration time of DPSK (Unit: Seconds)",
            "type": "number"
          },
          "createDateTime": {
            "description": "Creationd time of DPSK",
            "type": "number"
          }
        }
      }
    }
  }
}

Modify interval of delete expired DPSK

PUT/v11_1/rkszones/{zoneId}/deleteExpiredDpsk

Use this API command to modify interval of delete expired DPSK of a zone.

Request
HideShow
Body
{
  "deleteExpiredDpsk": "AfterOneDay"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "deleteExpiredDpsk": {
      "description": "Delete expired DPSK interval of the Zone.",
      "type": "string",
      "enum": [
        "Never",
        "AfterOneDay",
        "AfterSixMonths"
      ]
    }
  }
}
Response  204

Update DPSK info By Id

PATCH/v11_1/rkszones/{zoneId}/wlans/{id}/dpsk/{dpskId}

Use this API command to update DPSK info.

Request
HideShow
Body
{
  "userName": "updateUserName01"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "userName": {
      "description": "User Name of DPSK",
      "type": "string"
    }
  }
}
Response  204

Identity User

Retrieve Identity User List

GET/v11_1/identity/users

Use this API command to retrieve a list of identity user.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

timeZone
string (optional) 

Display created date and time by specified time zone. Default is UTC.

userName
string (optional) 

filter identity user list by user name.

displayName
string (optional) 

filter identity user list by display name.

firstName
string (optional) 

filter identity user list by first name.

lastName
string (optional) 

filter identity user list by last name.

email
string (optional) 

filter identity user list by email.

phone
string (optional) 

filter identity user list by phone.

userType
string (optional) 

filter identity user list by user type.

userSource
string (optional) 

filter identity user list by user source.

isDisabled
string (optional) 

filter identity user list by isDisabled.

createdOnFrom
string (optional) 

filter identity user list by created date and time. The start time of created date and time.

createdOnTo
string (optional) 

filter identity user list by created date and time. The end time of created date and time.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "09115c82-a049-4609-8fd8-1100b875592d",
      "displayName": "display name",
      "userName": "user name",
      "userSource": "Local Database",
      "userType": "LOCAL",
      "isDisabled": "NO",
      "createdOn": "2015/09/25 15:49:37"
    },
    {
      "id": "b5f02dbf-c769-436d-ae2d-44a6af194b57",
      "displayName": "display name",
      "userName": "user name",
      "userSource": "Local Database",
      "userType": "LOCAL",
      "isDisabled": "NO",
      "createdOn": "2015/09/23 16:35:44"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for identity user",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the identity user",
            "type": "string"
          },
          "displayName": {
            "description": "Display name",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "userName": {
            "description": "User Name",
            "type": "string"
          },
          "userSource": {
            "description": "User Source",
            "type": "string"
          },
          "userType": {
            "description": "User Type",
            "type": "string"
          },
          "isDisabled": {
            "description": "Is disalbed",
            "type": "string"
          },
          "createdOn": {
            "description": "Created on",
            "type": "string"
          },
          "domainId": {
            "description": "identifier of the domain",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve Package List

GET/v11_1/identity/users/packages

Use this API command to retrieve a list of packages.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "subscriberPackage": {
        "id": "839f87c6-d116-497e-afce-aa8157abd30c",
        "name": "External User Package"
      },
      "packageExpiration": "2 Years",
      "packageExpirationDate": 1482915055600
    },
    {
      "subscriberPackage": {
        "id": "f482f1ce-d7a7-4c55-b582-0ae3eccd4489",
        "name": "Local User Package"
      },
      "packageExpiration": "Never Expires"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "subscriberPackage": {
            "description": "Subscriber package",
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          },
          "packageExpiration": {
            "description": "Package expiration interval and value",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve Country List

GET/v11_1/identity/users/countries

Use this API command to retrieve a list of countries.

Response  200
HideShow
Body
{
  "totalCount": 3,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "countryShortName": "HU",
      "countryName": "HUNGARY"
    },
    {
      "countryShortName": "AE",
      "countryName": "UNITED ARAB EMIRATES"
    },
    {
      "countryShortName": "UZ",
      "countryName": "UZBEKISTAN"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "countryShortName": {
            "description": "Short name of country",
            "type": "string"
          },
          "countryName": {
            "description": "Full name of country",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve

GET/v11_1/identity/users/{id}

Use this API command to retrieve identity user.

Response  200
HideShow
Body
{
  "userName": "username",
  "password": "",
  "firstName": "firstname",
  "lastName": "lastname",
  "email": "[email protected]",
  "phone": "99-999-9999",
  "address": "address",
  "city": "city name",
  "state": "state name",
  "zipCode": "zip code",
  "countryName": "TAIWAN",
  "countryShortName": "TW",
  "remark": "remark description",
  "subscriberPackage": {
    "id": "f482f1ce-d7a7-4c55-b582-0ae3eccd4489",
    "name": "Local User Package"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "firstName": {
      "description": "First name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32
    },
    "lastName": {
      "description": "Last Name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32
    },
    "email": {
      "description": "Email",
      "type": "string"
    },
    "phone": {
      "description": "Phone",
      "type": "string",
      "minLength": 2,
      "maxLength": 32
    },
    "address": {
      "description": "Address",
      "type": "string",
      "minLength": 2,
      "maxLength": 256
    },
    "city": {
      "description": "City",
      "type": "string",
      "minLength": 2,
      "maxLength": 50
    },
    "state": {
      "description": "State",
      "type": "string",
      "minLength": 2,
      "maxLength": 32
    },
    "zipCode": {
      "description": "Zip Code",
      "type": "string",
      "minLength": 2,
      "maxLength": 32
    },
    "countryName": {
      "description": "Country",
      "type": "string"
    },
    "countryShortName": {
      "description": "Country",
      "type": "string"
    },
    "remark": {
      "description": "Remark",
      "type": "string",
      "minLength": 2,
      "maxLength": 32
    },
    "userName": {
      "description": "User Name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64
    },
    "subscriberPackage": {
      "description": "Subscriber package",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isDisabled": {
      "description": "Is Disabled",
      "type": "string",
      "enum": [
        "NO",
        "YES"
      ]
    },
    "packageStatus": {
      "description": "Package Status",
      "type": "string",
      "enum": [
        "DEPLETED",
        "AVAILABLE",
        "EXPIRED",
        "TERMINATED",
        "REMOVED"
      ]
    },
    "packageExpirationInterval": {
      "description": "Package Expiration Interval",
      "type": "string",
      "enum": [
        "HOUR",
        "DAY",
        "WEEK",
        "MONTH",
        "YEAR",
        "NEVER"
      ]
    },
    "packageExpirationValue": {
      "description": "Package Expiration Value",
      "type": "integer"
    },
    "packageExpirationDate": {
      "description": "Package Expiration Date",
      "type": "integer",
      "format": "int64"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    },
    "usernamePasswordCredentialsImplDto": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "loginName": {
          "description": "Login Name",
          "type": "string"
        },
        "loginPassword": {
          "description": "Login Password",
          "type": "string"
        },
        "key": {
          "description": "identifier of the UsernamePasswordCredentialsImplDto",
          "type": "string"
        },
        "serviceProviderId": {
          "description": "Service Provider Id",
          "type": "string"
        },
        "creationDate": {
          "description": "Creation Date",
          "type": "integer"
        },
        "expirationDate": {
          "description": "Expiration Date",
          "type": "integer"
        },
        "authenticationMethod": {
          "description": "Authentication Method",
          "type": "string",
          "enum": [
            "USERNAME_PASSWORD",
            "GUEST_PASS",
            "MAC_WLAN_DPSK",
            "MO",
            "REMOTE",
            "OAUTH2"
          ]
        },
        "authenticationServerConfig": {
          "description": "Server configuration",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "id": {
              "description": "server id",
              "type": "string"
            },
            "name": {
              "description": "server name",
              "type": "string"
            },
            "type": {
              "description": "server type",
              "type": "string"
            },
            "local": {
              "description": "Is local server",
              "type": "boolean"
            },
            "AUTHENTICATION_SERVER_TYPE": {
              "description": "Authentication server type",
              "type": "string",
              "enum": [
                "authenticationServerType"
              ]
            },
            "AUTHENTICATION_SERVER_NAME": {
              "description": "Authentication server name",
              "type": "string",
              "enum": [
                "authenticationServerName"
              ]
            },
            "AUTHENTICATION_SERVER_ID": {
              "description": "Authentication server id",
              "type": "string",
              "enum": [
                "authenticationServerId"
              ]
            }
          }
        },
        "passwordCreation": {
          "description": "Creation Date of Password",
          "type": "string"
        },
        "passwordExpiration": {
          "description": "Expiration Date of Password",
          "type": "string"
        }
      }
    },
    "credentialsGuestPassDto": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "authenticationMethod": {
          "description": "Authentication method of credential",
          "type": "string",
          "enum": [
            "GUEST_PASS"
          ]
        },
        "key": {
          "description": "Key of this guest pass",
          "type": "string"
        },
        "serviceProviderId": {
          "description": "Service Provider Id",
          "type": "string"
        },
        "creationDate": {
          "description": "Creation Date",
          "type": "integer"
        },
        "expirationDate": {
          "description": "Expiration date and time",
          "type": "string"
        },
        "userKey": {
          "description": "user ID of the identity guest pass",
          "type": "string"
        },
        "userName": {
          "description": "Username of this guest pass",
          "type": "string"
        },
        "displayName": {
          "description": "filter identity user list by display name",
          "type": "string"
        },
        "loginPassword": {
          "description": "Login Password",
          "type": "string"
        },
        "guestExpiration": {
          "description": "Expiration time of guest pass",
          "type": "integer"
        },
        "wlan": {
          "description": "WLAN Id",
          "type": "string"
        },
        "wlanName": {
          "description": "WLAN Name",
          "type": "string"
        },
        "maxDevices": {
          "description": "Maximum number of allowed device",
          "type": "integer"
        },
        "expirationValue": {
          "type": "integer"
        },
        "expirationUnit": {
          "type": "string",
          "enum": [
            "HOUR",
            "DAY",
            "WEEK"
          ]
        },
        "sessionUnit": {
          "type": "string",
          "enum": [
            "MIN",
            "HOUR",
            "DAY",
            "WEEK"
          ]
        },
        "sessionValue": {
          "type": "integer"
        },
        "domainId": {
          "description": "identifier of the domain",
          "type": "string"
        },
        "expireAfterIfNotUsed": {
          "type": "integer"
        },
        "macAddressList": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "autoGeneratePassword": {
          "description": "Pass generation",
          "type": "boolean"
        },
        "creatorId": {
          "description": "Creator ID",
          "type": "string"
        },
        "comment": {
          "type": "string"
        }
      }
    }
  }
}

Retrieve AAAServer List

GET/v11_1/identity/users/aaaserver

Use this API command to retrieve a list of aaa server.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "94b5c120-6014-11e5-b24f-525400c0e1b3",
      "name": "globalRadius"
    },
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "name": "Local Database"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "the identifier of the AAA server",
            "type": "string"
          },
          "name": {
            "description": "the identifier of the AAA server",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve Identity User List

POST/v11_1/identity/userList

Use this API command to retrieve a list of identity user. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "page": 1,
  "limit": 10
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq"
            ]
          }
        },
        "required": [
          "type",
          "value"
        ]
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query",
          "type": "string"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query",
          "type": "string"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "09115c82-a049-4609-8fd8-1100b875592d",
      "displayName": "display name",
      "userName": "user name",
      "userSource": "Local Database",
      "userType": "LOCAL",
      "isDisabled": "NO",
      "createdOn": "2015/09/25 15:49:37"
    },
    {
      "id": "b5f02dbf-c769-436d-ae2d-44a6af194b57",
      "displayName": "display name",
      "userName": "user name",
      "userSource": "Local Database",
      "userType": "LOCAL",
      "isDisabled": "NO",
      "createdOn": "2015/09/23 16:35:44"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for identity user",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the identity user",
            "type": "string"
          },
          "displayName": {
            "description": "Display name",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "userName": {
            "description": "User Name",
            "type": "string"
          },
          "userSource": {
            "description": "User Source",
            "type": "string"
          },
          "userType": {
            "description": "User Type",
            "type": "string"
          },
          "isDisabled": {
            "description": "Is disalbed",
            "type": "string"
          },
          "createdOn": {
            "description": "Created on",
            "type": "string"
          },
          "domainId": {
            "description": "identifier of the domain",
            "type": "string"
          }
        }
      }
    }
  }
}

Create

POST/v11_1/identity/users

Use this API command to create identity user.

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "firstName": "first name",
  "lastName": "last name",
  "email": "[email protected]",
  "phone": "999-9-9999999",
  "address": "address",
  "city": "city",
  "state": "state",
  "zipCode": "11023",
  "countryName": "TAIWAN",
  "countryShortName": "TW",
  "remark": "remark description",
  "userName": "ruckus",
  "password": "password",
  "isDisabled": "NO",
  "subscriberPackage": {
    "id": "f482f1ce-d7a7-4c55-b582-0ae3eccd4489"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "firstName": {
      "description": "First name",
      "type": "string"
    },
    "lastName": {
      "description": "Last Name",
      "type": "string"
    },
    "email": {
      "description": "Email",
      "type": "string"
    },
    "phone": {
      "description": "Phone",
      "type": "string"
    },
    "address": {
      "description": "Address",
      "type": "string"
    },
    "city": {
      "description": "City",
      "type": "string"
    },
    "state": {
      "description": "State",
      "type": "string"
    },
    "zipCode": {
      "description": "Zip Code",
      "type": "string"
    },
    "countryName": {
      "description": "Country",
      "type": "string"
    },
    "countryShortName": {
      "description": "Country",
      "type": "string"
    },
    "isDisabled": {
      "description": "Is Disabled",
      "type": "string",
      "enum": [
        "NO",
        "YES"
      ]
    },
    "remark": {
      "description": "Remark",
      "type": "string"
    },
    "userName": {
      "description": "User Name",
      "type": "string"
    },
    "password": {
      "description": "Password",
      "type": "string"
    },
    "domainId": {
      "description": "Domain ID",
      "type": "string"
    },
    "subscriberPackage": {
      "description": "Subscriber package",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "firstName",
    "lastName",
    "isDisabled",
    "userName",
    "password"
  ]
}
Response  201
HideShow
Body
{
  "id": "e5db11b3-71ff-4234-80d0-c7562e9868af"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v11_1/identity/users/{id}

Use this API command to modify the configuration of identity user.

Request
HideShow
Body
{
  "firstName": "first name",
  "lastName": "last name",
  "email": "[email protected]",
  "phone": "999-9-9999999",
  "address": "address",
  "city": "city",
  "state": "state",
  "zipCode": "11023",
  "countryName": "TAIWAN",
  "countryShortName": "TW",
  "remark": "remark description",
  "password": "password",
  "subscriberPackage": {
    "id": "f482f1ce-d7a7-4c55-b582-0ae3eccd4489"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "ID",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "firstName": {
      "description": "First name",
      "type": "string"
    },
    "lastName": {
      "description": "Last Name",
      "type": "string"
    },
    "email": {
      "description": "Email",
      "type": "string"
    },
    "phone": {
      "description": "Phone",
      "type": "string"
    },
    "address": {
      "description": "Address",
      "type": "string"
    },
    "city": {
      "description": "City",
      "type": "string"
    },
    "state": {
      "description": "State",
      "type": "string"
    },
    "zipCode": {
      "description": "Zip Code",
      "type": "string"
    },
    "countryName": {
      "description": "Country",
      "type": "string"
    },
    "countryShortName": {
      "description": "Country",
      "type": "string"
    },
    "isDisabled": {
      "description": "Is Disabled",
      "type": "string",
      "enum": [
        "NO",
        "YES"
      ]
    },
    "remark": {
      "description": "Remark",
      "type": "string"
    },
    "password": {
      "description": "Password",
      "type": "string"
    },
    "subscriberPackage": {
      "description": "Subscriber package",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}
Response  204

Delete

DELETE/v11_1/identity/users/{id}

Use this API command to delete identity user.

Response  204

Delete Multiple Identity Users

DELETE/v11_1/identity/users

Use this API command to delete multiple identity users.

Request
HideShow
Body
{
  "idList": [
    "b5f02dbf-c769-436d-ae2d-44a6af194b57",
    "839f87c6-d116-497e-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Identity User Role

Retrieve

GET/v11_1/identity/userrole/{id}

Use this API command to retrieve identity user role by ID.

Response  200
HideShow
Body
{
  "id": "e5db11b3-71ff-4234-80d0-c7562e9868af",
  "name": "identity user role name",
  "description": "identity user role desc",
  "userTrafficProfile": {
    "id": "91c3fcf0-2f83-11e5-a2b8-000c29cf8ec4",
    "name": "userTrafficProfile"
  },
  "firewallProfileId": "835c04c1-ae85-11e9-8716-221ecf86dac9",
  "maxDevices": {
    "maxDevicesAllowed": "UNLIMITED",
    "maxDevicesNumber": 0
  },
  "vlanId": 2,
  "vlanPooling": {
    "id": "703de900-6840-11e6-93dc-fe81f3ac8ddd",
    "name": "vlanPooling"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the object",
      "type": "string"
    },
    "name": {
      "description": "name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "description": {
      "description": "description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "userTrafficProfile": {
      "description": "User traffic profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "firewallProfileId": {
      "type": "string"
    },
    "maxDevices": {
      "description": "max Devices",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "maxDevicesAllowed": {
          "description": "Max devices allowed",
          "type": "string",
          "enum": [
            "UNLIMITED",
            "LIMITED"
          ],
          "default": "LIMITED"
        },
        "maxDevicesNumber": {
          "description": "max devices number",
          "type": "integer",
          "default": 3,
          "minimum": 1,
          "maximum": 10
        }
      }
    },
    "vlanId": {
      "description": "vlan id",
      "type": "integer"
    },
    "vlanPooling": {
      "description": "VLAN pooling profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    },
    "timeSchedulePolicy": {
      "description": "Time schedule policy",
      "type": "string"
    },
    "timeScheduleList": {
      "description": "Time schedule list",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sun": {
          "description": "Schedules on Sunday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "mon": {
          "description": "Schedules on Monday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "tue": {
          "description": "Schedules on Tuesday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "wed": {
          "description": "schedules on Wednesday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "thu": {
          "description": "Schedules on Thursday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "fri": {
          "description": "Schedules on Friday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "sat": {
          "description": "Schedules on Saturday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        }
      }
    }
  }
}

Retrieve List

GET/v11_1/identity/userrole

Use this API command to retrieve a list of identity user role.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "c5dfc930-75dc-11e4-8d56-00606eb0c700",
      "name": "identity name",
      "description": "identity user role desc",
      "userTrafficProfile": {
        "id": "91c3fcf0-2f83-11e5-a2b8-000c29cf8ec4",
        "name": "userTrafficProfile"
      },
      "firewallProfileId": "835c04c1-ae85-11e9-8716-221ecf86dac9",
      "maxDevices": {
        "maxDevicesAllowed": "UNLIMITED",
        "maxDevicesNumber": 0
      },
      "vlanId": 2,
      "vlanPooling": {
        "id": "703de900-6840-11e6-93dc-fe81f3ac8ddd",
        "name": "vlanPooling"
      }
    },
    {
      "id": "15efd160-7153-11e4-aa08-00606eb0c700",
      "name": "identity name",
      "description": "identity user role desc",
      "userTrafficProfile": {
        "id": "91c3fcf0-2f83-11e5-a2b8-000c29cf8ec4",
        "name": "userTrafficProfile"
      },
      "firewallProfileId": "835c04c1-ae85-11e9-8716-221ecf86dac9",
      "maxDevices": {
        "maxDevicesAllowed": "UNLIMITED",
        "maxDevicesNumber": 0
      },
      "vlanId": 2,
      "vlanPooling": {
        "id": "703de900-6840-11e6-93dc-fe81f3ac8ddd",
        "name": "vlanPooling"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for Identity roles",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the service",
            "type": "string"
          },
          "name": {
            "description": "Name of the service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "description",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "userTrafficProfile": {
            "description": "User traffic profile",
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          },
          "firewallProfileId": {
            "type": "string"
          },
          "maxDevices": {
            "description": "max Devices",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "maxDevicesAllowed": {
                "description": "Max devices allowed",
                "type": "string",
                "enum": [
                  "UNLIMITED",
                  "LIMITED"
                ],
                "default": "LIMITED"
              },
              "maxDevicesNumber": {
                "description": "max devices number",
                "type": "integer",
                "default": 3,
                "minimum": 1,
                "maximum": 10
              }
            }
          },
          "vlanId": {
            "description": "vlan id",
            "type": "integer"
          },
          "vlanPooling": {
            "description": "VLAN pooling profile",
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          },
          "timeSchedulePolicy": {
            "description": "Time schedule policy",
            "type": "string",
            "enum": [
              "ALLOW_ALL",
              "ALLOW_SPECIFIC"
            ],
            "default": "ALLOW_ALL"
          },
          "timeScheduleList": {
            "description": "Time schedule list",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "sun": {
                "description": "Schedules on Sunday",
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
                }
              },
              "mon": {
                "description": "Schedules on Monday",
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
                }
              },
              "tue": {
                "description": "Schedules on Tuesday",
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
                }
              },
              "wed": {
                "description": "schedules on Wednesday",
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
                }
              },
              "thu": {
                "description": "Schedules on Thursday",
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
                }
              },
              "fri": {
                "description": "Schedules on Friday",
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
                }
              },
              "sat": {
                "description": "Schedules on Saturday",
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
                }
              }
            }
          },
          "domainId": {
            "description": "identifier of the domain",
            "type": "string"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve List

POST/v11_1/identity/userRoleList

Use this API command to retrieve a list of identity user role. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "page": 1,
  "limit": 10
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq"
            ]
          }
        },
        "required": [
          "type",
          "value"
        ]
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query",
          "type": "string"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query",
          "type": "string"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "c5dfc930-75dc-11e4-8d56-00606eb0c700",
      "name": "identity name",
      "description": "identity user role desc",
      "userTrafficProfile": {
        "id": "91c3fcf0-2f83-11e5-a2b8-000c29cf8ec4",
        "name": "userTrafficProfile"
      },
      "firewallProfileId": "835c04c1-ae85-11e9-8716-221ecf86dac9",
      "maxDevices": {
        "maxDevicesAllowed": "UNLIMITED",
        "maxDevicesNumber": 0
      },
      "vlanId": 2,
      "vlanPooling": {
        "id": "703de900-6840-11e6-93dc-fe81f3ac8ddd",
        "name": "vlanPooling"
      }
    },
    {
      "id": "15efd160-7153-11e4-aa08-00606eb0c700",
      "name": "identity name",
      "description": "identity user role desc",
      "userTrafficProfile": {
        "id": "91c3fcf0-2f83-11e5-a2b8-000c29cf8ec4",
        "name": "userTrafficProfile"
      },
      "firewallProfileId": "835c04c1-ae85-11e9-8716-221ecf86dac9",
      "maxDevices": {
        "maxDevicesAllowed": "UNLIMITED",
        "maxDevicesNumber": 0
      },
      "vlanId": 2,
      "vlanPooling": {
        "id": "703de900-6840-11e6-93dc-fe81f3ac8ddd",
        "name": "vlanPooling"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for Identity roles",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the service",
            "type": "string"
          },
          "name": {
            "description": "Name of the service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "description",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "userTrafficProfile": {
            "description": "User traffic profile",
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          },
          "firewallProfileId": {
            "type": "string"
          },
          "maxDevices": {
            "description": "max Devices",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "maxDevicesAllowed": {
                "description": "Max devices allowed",
                "type": "string",
                "enum": [
                  "UNLIMITED",
                  "LIMITED"
                ],
                "default": "LIMITED"
              },
              "maxDevicesNumber": {
                "description": "max devices number",
                "type": "integer",
                "default": 3,
                "minimum": 1,
                "maximum": 10
              }
            }
          },
          "vlanId": {
            "description": "vlan id",
            "type": "integer"
          },
          "vlanPooling": {
            "description": "VLAN pooling profile",
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          },
          "timeSchedulePolicy": {
            "description": "Time schedule policy",
            "type": "string",
            "enum": [
              "ALLOW_ALL",
              "ALLOW_SPECIFIC"
            ],
            "default": "ALLOW_ALL"
          },
          "timeScheduleList": {
            "description": "Time schedule list",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "sun": {
                "description": "Schedules on Sunday",
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
                }
              },
              "mon": {
                "description": "Schedules on Monday",
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
                }
              },
              "tue": {
                "description": "Schedules on Tuesday",
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
                }
              },
              "wed": {
                "description": "schedules on Wednesday",
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
                }
              },
              "thu": {
                "description": "Schedules on Thursday",
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
                }
              },
              "fri": {
                "description": "Schedules on Friday",
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
                }
              },
              "sat": {
                "description": "Schedules on Saturday",
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
                }
              }
            }
          },
          "domainId": {
            "description": "identifier of the domain",
            "type": "string"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Create

POST/v11_1/identity/userrole

Use this API command to create identity user role.

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "create-identity-user-role-name",
  "description": "create identity user role desc",
  "userTrafficProfile": {
    "name": "utp"
  },
  "firewallProfileId": "835c04c1-ae85-11e9-8716-221ecf86dac9",
  "maxDevices": {
    "maxDevicesAllowed": "LIMITED",
    "maxDevicesNumber": 3
  },
  "vlanId": 2,
  "vlanPooling": {
    "name": "vlanPooling"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "description": "name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "description": {
      "description": "description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "userTrafficProfile": {
      "description": "User traffic profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "firewallProfileId": {
      "type": "string"
    },
    "maxDevices": {
      "description": "max Devices",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "maxDevicesAllowed": {
          "description": "Max devices allowed",
          "type": "string",
          "enum": [
            "UNLIMITED",
            "LIMITED"
          ],
          "default": "LIMITED"
        },
        "maxDevicesNumber": {
          "description": "max devices number",
          "type": "integer",
          "default": 3,
          "minimum": 1,
          "maximum": 10
        }
      }
    },
    "vlanId": {
      "description": "vlan id",
      "type": "integer",
      "minimum": 1,
      "maximum": 4096
    },
    "vlanPooling": {
      "description": "VLAN pooling profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "timeSchedulePolicy": {
      "description": "Time schedule policy",
      "type": "string",
      "enum": [
        "ALLOW_ALL",
        "ALLOW_SPECIFIC"
      ],
      "default": "ALLOW_ALL"
    },
    "timeScheduleList": {
      "description": "Time schedule list",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sun": {
          "description": "Schedules on Sunday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "mon": {
          "description": "Schedules on Monday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "tue": {
          "description": "Schedules on Tuesday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "wed": {
          "description": "schedules on Wednesday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "thu": {
          "description": "Schedules on Thursday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "fri": {
          "description": "Schedules on Friday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "sat": {
          "description": "Schedules on Saturday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        }
      }
    }
  },
  "required": [
    "name",
    "userTrafficProfile",
    "firewallProfileId",
    "maxDevices"
  ]
}
Response  201
HideShow
Body
{
  "id": "e5db11b3-71ff-4234-80d0-c7562e9868af"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v11_1/identity/userrole/{id}

Use this API command to modify the configuration of identity user role.

Request
HideShow
Body
{
  "name": "modify-userrole-test",
  "description": "modify user role test",
  "userTrafficProfile": {
    "name": "userTrafficProfileName"
  },
  "firewallProfileId": "835c04c1-ae85-11e9-8716-221ecf86dac9",
  "maxDevices": {
    "maxDevicesAllowed": "LIMITED",
    "maxDevicesNumber": 3
  },
  "vlanId": 2,
  "vlanPooling": {
    "name": "vlanPooling"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "ID",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "description": "name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "description": {
      "description": "description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "userTrafficProfile": {
      "description": "User traffic profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "firewallProfileId": {
      "type": "string"
    },
    "maxDevices": {
      "description": "max Devices",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "maxDevicesAllowed": {
          "description": "Max devices allowed",
          "type": "string",
          "enum": [
            "UNLIMITED",
            "LIMITED"
          ]
        },
        "maxDevicesNumber": {
          "description": "max devices number",
          "type": "integer",
          "minimum": 1,
          "maximum": 10
        }
      }
    },
    "vlanId": {
      "description": "vlan id",
      "type": "integer",
      "minimum": 1,
      "maximum": 4096
    },
    "vlanPooling": {
      "description": "VLAN pooling profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "timeSchedulePolicy": {
      "description": "Time schedule policy",
      "type": "string",
      "enum": [
        "ALLOW_ALL",
        "ALLOW_SPECIFIC"
      ]
    },
    "timeScheduleList": {
      "description": "Time schedule list",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sun": {
          "description": "Schedules on Sunday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "mon": {
          "description": "Schedules on Monday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "tue": {
          "description": "Schedules on Tuesday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "wed": {
          "description": "schedules on Wednesday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "thu": {
          "description": "Schedules on Thursday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "fri": {
          "description": "Schedules on Friday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        },
        "sat": {
          "description": "Schedules on Saturday",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
          }
        }
      }
    }
  }
}
Response  204

Delete

DELETE/v11_1/identity/userrole/{id}

Use this API command to delete identity user role.

Response  204

Delete Multiple Identity User Roles

DELETE/v11_1/identity/userrole

Use this API command to delete multiple identity user roles.

Request
HideShow
Body
{
  "idList": [
    "b5f02dbf-c769-436d-ae2d-44a6af194b57",
    "839f87c6-d116-497e-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Identity Guest Pass

Retrieve Identity Guest Pass List

GET/v11_1/identity/guestpass

Use this API command to retrieve a list of identity guest pass.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

timeZone
string (optional) 

Display created date and time by specified time zone. Default is UTC.

wlan
string (optional) 

filter identity guest pass list by wlan id.

displayName
string (optional) 

filter identity guest pass list by display name.

expirationFrom
string (optional) 

filter identity guest pass list by expiration date and time. The start time of expiration date and time.The format is yyyy-MM-dd HH:mm:ss.

expirationTo
string (optional) 

filter identity guest pass list by expiration date and time. The end time of expiration date and time.The format is yyyy-MM-dd HH:mm:ss.

generatedTimeFrom
string (optional) 

filter identity guest pass list by generated date and time. The start time of generated date and time.The format is yyyy-MM-dd HH:mm:ss.

generatedTimeTo
string (optional) 

filter identity guest pass list by generated date and time. The end time of generated date and time.The format is yyyy-MM-dd HH:mm:ss.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "24cfb9af-4b3f-4d0a-8a92-b2eba022687b",
      "userId": "afdfc09e-ef23-4d93-8598-8ed95fe67460",
      "key": "6ygwR3B2",
      "guestName": "guest-name-1",
      "remarks": "remark",
      "generatedOn": "2015/10/26 10:19:30",
      "expirationDate": "2015/10/27 10:19:30",
      "wlanRestrition": "[wlan-name] of [zone-name]"
    },
    {
      "id": "b28ff2cc-e0f6-4e58-b520-46b29be613ea",
      "userId": "ab96f27b-1145-4371-85c6-1c1eaa9aff6f",
      "key": "J8cjtQM9",
      "guestName": "guest-name-2",
      "remarks": "remark",
      "generatedOn": "2015/10/26 09:54:36",
      "expirationDate": "2015/10/27 00:54:36",
      "wlanRestrition": "[wlan-name] of [zone-name]"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for GuestPass",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "ID of the identity guest pass",
            "type": "string"
          },
          "userId": {
            "description": "user ID of the identity guest pass",
            "type": "string"
          },
          "key": {
            "description": "Identifier of the identity guest pass",
            "type": "string"
          },
          "guestName": {
            "description": "Guest name of the identity guest pass",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "wlan": {
            "description": "wlan",
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          },
          "zone": {
            "description": "zone",
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          },
          "ssid": {
            "description": "SSID",
            "type": "string"
          },
          "passValidFor": {
            "description": "Pass valid for",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "expirationValue": {
                "type": "integer"
              },
              "expirationUnit": {
                "type": "string",
                "enum": [
                  "HOUR",
                  "DAY",
                  "WEEK"
                ]
              }
            }
          },
          "maxDevices": {
            "description": "max Devices",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "maxDevicesAllowed": {
                "description": "Max devices allowed",
                "type": "string",
                "enum": [
                  "UNLIMITED",
                  "LIMITED"
                ],
                "default": "LIMITED"
              },
              "maxDevicesNumber": {
                "description": "max devices number",
                "type": "integer",
                "default": 3,
                "minimum": 1,
                "maximum": 10
              }
            }
          },
          "autoGeneratedPassword": {
            "description": "Pass generation",
            "type": "boolean"
          },
          "passEffectSince": {
            "description": "Pass effective since",
            "type": "string",
            "enum": [
              "CREATION_TIME",
              "FIRST_USE"
            ]
          },
          "passUseDays": {
            "description": "Expire new guest pass if not used within",
            "type": "integer",
            "format": "int64"
          },
          "remarks": {
            "description": "Remarks",
            "type": "string"
          },
          "generatedOn": {
            "description": "Generated date and time",
            "type": "string"
          },
          "expirationDate": {
            "description": "Expiration date and time",
            "type": "string"
          },
          "wlanRestrition": {
            "description": "Wlan description",
            "type": "string"
          },
          "sessionDuration": {
            "description": "session duration",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "requireLoginAgain": {
                "type": "boolean"
              },
              "sessionValue": {
                "type": "integer"
              },
              "sessionUnit": {
                "type": "string",
                "enum": [
                  "MIN",
                  "HOUR",
                  "DAY",
                  "WEEK"
                ]
              }
            }
          },
          "domainId": {
            "description": "identifier of the domain",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Username who generate this GuestPass",
            "type": "string"
          },
          "isDisabled": {
            "description": "Is Disabled",
            "type": "string"
          }
        }
      }
    }
  }
}

Generate Identity Guest Pass

POST/v11_1/identity/guestpass/generate

Use this API command to generate identity guest pass.

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "guestName": "guest name",
  "wlan": {
    "name": "wlan name"
  },
  "zone": {
    "name": "zone name"
  },
  "numberOfPasses": 1,
  "passValidFor": {
    "expirationValue": 15,
    "expirationUnit": "HOUR"
  },
  "autoGeneratedPassword": true,
  "passEffectSince": "CREATION_TIME",
  "passUseDays": 7,
  "maxDevices": {
    "maxDevicesAllowed": "LIMITED",
    "maxDevicesNumber": 3
  },
  "sessionDuration": {
    "requireLoginAgain": true,
    "sessionValue": 3,
    "sessionUnit": "DAY"
  },
  "remarks": "comment"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "type": "string",
      "description": "Domain Id"
    },
    "guestName": {
      "description": "Guest name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "wlan": {
      "description": "wlan id",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "zone": {
      "description": "zone id",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "numberOfPasses": {
      "description": "Number of passes",
      "type": "integer"
    },
    "passValidFor": {
      "description": "Pass valid for",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "expirationValue": {
          "type": "integer"
        },
        "expirationUnit": {
          "type": "string",
          "enum": [
            "HOUR",
            "DAY",
            "WEEK"
          ]
        }
      }
    },
    "autoGeneratedPassword": {
      "description": "Pass generation",
      "type": "boolean"
    },
    "passValue": {
      "description": "Pass value",
      "type": "string"
    },
    "passEffectSince": {
      "description": "Pass effective since",
      "type": "string",
      "enum": [
        "CREATION_TIME",
        "FIRST_USE"
      ]
    },
    "passUseDays": {
      "description": "Expire new guest pass if not used within",
      "type": "integer",
      "format": "int64"
    },
    "maxDevices": {
      "description": "max Devices",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "maxDevicesAllowed": {
          "description": "Max devices allowed",
          "type": "string",
          "enum": [
            "UNLIMITED",
            "LIMITED"
          ],
          "default": "LIMITED"
        },
        "maxDevicesNumber": {
          "description": "max devices number",
          "type": "integer",
          "default": 3,
          "minimum": 1,
          "maximum": 10
        }
      }
    },
    "sessionDuration": {
      "description": "session duration",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "requireLoginAgain": {
          "type": "boolean"
        },
        "sessionValue": {
          "type": "integer"
        },
        "sessionUnit": {
          "type": "string",
          "enum": [
            "MIN",
            "HOUR",
            "DAY",
            "WEEK"
          ]
        }
      }
    },
    "remarks": {
      "description": "Remarks",
      "type": "string"
    }
  },
  "required": [
    "guestName",
    "wlan",
    "zone",
    "numberOfPasses",
    "passValidFor",
    "passEffectSince",
    "maxDevices"
  ]
}
Response  201
HideShow
Body
{
  "id": "e5db11b3-71ff-4234-80d0-c7562e9868af"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Import Identity Guest Pass

POST/v11_1/identity/guestpass/upload

Use this API command to upload identity guest pass csv file.

Request
HideShow
Headers
Content-Type: multipart/form-data
Response  200

Common Identity Guest Pass Settings

POST/v11_1/identity/guestpass/upload/common

Use this API command to update common identity guest pass settings.

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "wlan": {
    "name": "wlan name"
  },
  "zone": {
    "name": "zone name"
  },
  "passValidFor": {
    "expirationValue": 15,
    "expirationUnit": "HOUR"
  },
  "passEffectSince": "CREATION_TIME",
  "passUseDays": 7,
  "maxDevices": {
    "maxDevicesAllowed": "LIMITED",
    "maxDevicesNumber": 3
  },
  "sessionDuration": {
    "requireLoginAgain": true,
    "sessionValue": 3,
    "sessionUnit": "DAY"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "wlan": {
      "description": "wlan id",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "zone": {
      "description": "zone id",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "passValidFor": {
      "description": "Pass valid for",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "expirationValue": {
          "type": "integer"
        },
        "expirationUnit": {
          "type": "string",
          "enum": [
            "HOUR",
            "DAY",
            "WEEK"
          ]
        }
      }
    },
    "passEffectSince": {
      "description": "Pass effective since",
      "type": "string",
      "enum": [
        "CREATION_TIME",
        "FIRST_USE"
      ]
    },
    "passUseDays": {
      "description": "Expire new guest pass if not used within",
      "type": "integer",
      "format": "int64"
    },
    "maxDevices": {
      "description": "max Devices",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "maxDevicesAllowed": {
          "description": "Max devices allowed",
          "type": "string",
          "enum": [
            "UNLIMITED",
            "LIMITED"
          ],
          "default": "LIMITED"
        },
        "maxDevicesNumber": {
          "description": "max devices number",
          "type": "integer",
          "default": 3,
          "minimum": 1,
          "maximum": 10
        }
      }
    },
    "sessionDuration": {
      "description": "session duration",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "requireLoginAgain": {
          "type": "boolean"
        },
        "sessionValue": {
          "type": "integer"
        },
        "sessionUnit": {
          "type": "string",
          "enum": [
            "MIN",
            "HOUR",
            "DAY",
            "WEEK"
          ]
        }
      }
    }
  },
  "required": [
    "wlan",
    "zone",
    "passValidFor",
    "maxDevices"
  ]
}
Response  201

Retrieve Identity Guest Pass List

POST/v11_1/identity/guestpassList

Use this API command to retrieve a list of identity guest pass. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "page": 1,
  "limit": 10
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq"
            ]
          }
        },
        "required": [
          "type",
          "value"
        ]
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query",
          "type": "string"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query",
          "type": "string"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "24cfb9af-4b3f-4d0a-8a92-b2eba022687b",
      "userId": "afdfc09e-ef23-4d93-8598-8ed95fe67460",
      "key": "6ygwR3B2",
      "guestName": "guest-name-1",
      "remarks": "remark",
      "generatedOn": "2015/10/26 10:19:30",
      "expirationDate": "2015/10/27 10:19:30",
      "wlanRestrition": "[wlan-name] of [zone-name]"
    },
    {
      "id": "b28ff2cc-e0f6-4e58-b520-46b29be613ea",
      "userId": "ab96f27b-1145-4371-85c6-1c1eaa9aff6f",
      "key": "J8cjtQM9",
      "guestName": "guest-name-2",
      "remarks": "remark",
      "generatedOn": "2015/10/26 09:54:36",
      "expirationDate": "2015/10/27 00:54:36",
      "wlanRestrition": "[wlan-name] of [zone-name]"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for GuestPass",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "ID of the identity guest pass",
            "type": "string"
          },
          "userId": {
            "description": "user ID of the identity guest pass",
            "type": "string"
          },
          "key": {
            "description": "Identifier of the identity guest pass",
            "type": "string"
          },
          "guestName": {
            "description": "Guest name of the identity guest pass",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "wlan": {
            "description": "wlan",
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          },
          "zone": {
            "description": "zone",
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          },
          "ssid": {
            "description": "SSID",
            "type": "string"
          },
          "passValidFor": {
            "description": "Pass valid for",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "expirationValue": {
                "type": "integer"
              },
              "expirationUnit": {
                "type": "string",
                "enum": [
                  "HOUR",
                  "DAY",
                  "WEEK"
                ]
              }
            }
          },
          "maxDevices": {
            "description": "max Devices",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "maxDevicesAllowed": {
                "description": "Max devices allowed",
                "type": "string",
                "enum": [
                  "UNLIMITED",
                  "LIMITED"
                ],
                "default": "LIMITED"
              },
              "maxDevicesNumber": {
                "description": "max devices number",
                "type": "integer",
                "default": 3,
                "minimum": 1,
                "maximum": 10
              }
            }
          },
          "autoGeneratedPassword": {
            "description": "Pass generation",
            "type": "boolean"
          },
          "passEffectSince": {
            "description": "Pass effective since",
            "type": "string",
            "enum": [
              "CREATION_TIME",
              "FIRST_USE"
            ]
          },
          "passUseDays": {
            "description": "Expire new guest pass if not used within",
            "type": "integer",
            "format": "int64"
          },
          "remarks": {
            "description": "Remarks",
            "type": "string"
          },
          "generatedOn": {
            "description": "Generated date and time",
            "type": "string"
          },
          "expirationDate": {
            "description": "Expiration date and time",
            "type": "string"
          },
          "wlanRestrition": {
            "description": "Wlan description",
            "type": "string"
          },
          "sessionDuration": {
            "description": "session duration",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "requireLoginAgain": {
                "type": "boolean"
              },
              "sessionValue": {
                "type": "integer"
              },
              "sessionUnit": {
                "type": "string",
                "enum": [
                  "MIN",
                  "HOUR",
                  "DAY",
                  "WEEK"
                ]
              }
            }
          },
          "domainId": {
            "description": "identifier of the domain",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Username who generate this GuestPass",
            "type": "string"
          },
          "isDisabled": {
            "description": "Is Disabled",
            "type": "string"
          }
        }
      }
    }
  }
}

Modify Identity Guest

PATCH/v11_1/identity/guestpass/{userId}

Use this API command to modify the configuration of identity guest.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "isDisabled": {
      "description": "Is Disabled",
      "type": "string",
      "enum": [
        "NO",
        "YES"
      ]
    }
  }
}
Response  204

Delete

DELETE/v11_1/identity/guestpass/{userId}

Use this API command to delete identity guest pass.

Response  204

Delete Multiple Identity Guest Passes

DELETE/v11_1/identity/guestpass

Use this API command to delete multiple identity guest passes.

Request
HideShow
Body
{
  "idList": [
    "b5f02dbf-c769-436d-ae2d-44a6af194b57",
    "839f87c6-d116-497e-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Identity Subscription Package

Retrieve

GET/v11_1/identity/packages/{id}

Use this API command to retrieve subscription package.

Response  200
HideShow
Body
{
  "name": "subscription-package-name",
  "description": "description",
  "expirationInterval": "DAY",
  "expirationValue": 3
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the subscription package",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "expirationInterval": {
      "description": "Expiration interval",
      "type": "string",
      "enum": [
        "HOUR",
        "DAY",
        "WEEK",
        "MONTH",
        "YEAR",
        "NEVER"
      ]
    },
    "expirationValue": {
      "description": "Expiration value",
      "type": "integer"
    },
    "domainId": {
      "description": "identifier of the domain",
      "type": "string"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Retrieve subscription package list

GET/v11_1/identity/packages

Use this API command to retrieve a list of subscription package.

Response  200
HideShow
Body
{
  "totalCount": 3,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "24cfb9af-4b3f-4d0a-8a92-b2eba022687b",
      "name": "subscription-package-name1",
      "description": "description",
      "expirationInterval": "HOUR",
      "expirationValue": 8
    },
    {
      "id": "839f87c6-d116-497e-afce-aa8157abd30c",
      "name": "External User Package",
      "description": "External User Package",
      "expirationInterval": "YEAR",
      "expirationValue": 2
    },
    {
      "id": "6547be7c-6787-487e-b672-f90faf77b6d0",
      "name": "Local User Package",
      "description": "Local User Package",
      "expirationInterval": "NEVER",
      "expirationValue": 0
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for subscription package",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "the identifier of the subscription package",
            "type": "string"
          },
          "name": {
            "description": "name of the subscription package",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "description of the subscription package",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "expirationInterval": {
            "description": "Expiration interval",
            "type": "string",
            "enum": [
              "HOUR",
              "DAY",
              "WEEK",
              "MONTH",
              "YEAR",
              "NEVER"
            ]
          },
          "expirationValue": {
            "description": "Expiration value",
            "type": "integer"
          },
          "domainId": {
            "description": "identifier of the domain",
            "type": "string"
          }
        }
      }
    }
  }
}

Create

POST/v11_1/identity/packages

Use this API command to create subscription package.

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "subscription-package-name",
  "description": "description",
  "expirationInterval": "HOUR",
  "expirationValue": 5
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "description": "name of subscription package",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the subscription package",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "expirationInterval": {
      "description": "Expiration interval",
      "type": "string",
      "enum": [
        "HOUR",
        "DAY",
        "WEEK",
        "MONTH",
        "YEAR",
        "NEVER"
      ]
    },
    "expirationValue": {
      "description": "Expiration value",
      "type": "integer"
    }
  },
  "required": [
    "name",
    "expirationInterval",
    "expirationValue"
  ]
}
Response  201
HideShow
Body
{
  "id": "e5db11b3-71ff-4234-80d0-c7562e9868af"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Retrieve subscription package list

POST/v11_1/identity/packageList

Use this API command to retrieve a list of subscription package. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "page": 1,
  "limit": 10
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq"
            ]
          }
        },
        "required": [
          "type",
          "value"
        ]
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query",
          "type": "string"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query",
          "type": "string"
        },
        "localUser_auditTime": {
          "description": "Audit time of local users",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time for auditTime",
              "type": "number"
            },
            "end": {
              "description": "end time for auditTime",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "localUser_firstName": {
          "description": "First name of local users",
          "type": "string"
        },
        "localUser_lastName": {
          "description": "Last name of local users",
          "type": "string"
        },
        "localUser_mailAddress": {
          "description": "Mail address of local users",
          "type": "string"
        },
        "localUser_primaryPhoneNumber": {
          "description": "Primary phone number of local users",
          "type": "string"
        },
        "localUser_displayName": {
          "description": "Display name of local users",
          "type": "string"
        },
        "localUser_userName": {
          "description": "User name of local users",
          "type": "string"
        },
        "localUser_userSource": {
          "description": "User source of local users",
          "type": "string"
        },
        "localUser_subscriberType": {
          "description": "Subscriber type of local users",
          "type": "string"
        },
        "localUser_status": {
          "description": "Status of local users",
          "type": "string"
        },
        "guestPass_displayName": {
          "description": "Display name of guest pass",
          "type": "string"
        },
        "guestPass_expiration": {
          "description": "Expiration time of guest pass",
          "type": "object",
          "properties": {
            "start": {
              "description": "start time of expiration",
              "type": "number"
            },
            "end": {
              "description": "end time of expiration",
              "type": "number"
            },
            "interval": {
              "description": "time interval in second",
              "type": "number"
            }
          }
        },
        "guestPass_wlan": {
          "description": "WLAN which used by quest pass",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 3,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "24cfb9af-4b3f-4d0a-8a92-b2eba022687b",
      "name": "subscription-package-name1",
      "description": "description",
      "expirationInterval": "HOUR",
      "expirationValue": 8
    },
    {
      "id": "839f87c6-d116-497e-afce-aa8157abd30c",
      "name": "External User Package",
      "description": "External User Package",
      "expirationInterval": "YEAR",
      "expirationValue": 2
    },
    {
      "id": "6547be7c-6787-487e-b672-f90faf77b6d0",
      "name": "Local User Package",
      "description": "Local User Package",
      "expirationInterval": "NEVER",
      "expirationValue": 0
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for subscription package",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "the identifier of the subscription package",
            "type": "string"
          },
          "name": {
            "description": "name of the subscription package",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "description of the subscription package",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "expirationInterval": {
            "description": "Expiration interval",
            "type": "string",
            "enum": [
              "HOUR",
              "DAY",
              "WEEK",
              "MONTH",
              "YEAR",
              "NEVER"
            ]
          },
          "expirationValue": {
            "description": "Expiration value",
            "type": "integer"
          },
          "domainId": {
            "description": "identifier of the domain",
            "type": "string"
          }
        }
      }
    }
  }
}

Modify

PATCH/v11_1/identity/packages/{id}

Use this API command to modify the configuration of subscription package.

Request
HideShow
Body
{
  "name": "subscription-package-name",
  "description": "description",
  "expirationInterval": "DAY",
  "expirationValue": 3
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "ID",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "name": {
      "description": "name of subscription package",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description of the subscription package",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "expirationInterval": {
      "description": "Expiration interval",
      "type": "string",
      "enum": [
        "HOUR",
        "DAY",
        "WEEK",
        "MONTH",
        "YEAR",
        "NEVER"
      ]
    },
    "expirationValue": {
      "description": "Expiration value",
      "type": "integer"
    }
  }
}
Response  204

Delete

DELETE/v11_1/identity/packages/{id}

Use this API command to delete subscription package.

Response  204

Delete

DELETE/v11_1/identity/packages

Use this API command to delete multiple subscription packages.

Request
HideShow
Body
{
  "idList": [
    "b5f02dbf-c769-436d-ae2d-44a6af194b57",
    "839f87c6-d116-497e-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

System

Retrieve Devices Summary

GET/v11_1/system/devicesSummary

Use this API command to retrieve devices summary.

Response  200
HideShow
Body
{
  "maxApOfCluster": 30000,
  "maxSwitchOfCluster": 3750,
  "apCapacity": 10000,
  "switchCapacity": 250,
  "totalApCapacity": 26000,
  "totalSwitchCapacity": 1000,
  "totalRemainingApCapacity": 4000,
  "totalRemainingSwitchCapacity": 500,
  "aps": 8000,
  "switches": 0,
  "totalAps": 22000,
  "totalSwitches": 500
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "maxApOfCluster": {
      "description": "maximum ap capacity per cluster.",
      "type": "integer"
    },
    "maxSwitchOfCluster": {
      "description": "maximum switch capacity per cluster.",
      "type": "integer"
    },
    "apCapacity": {
      "description": "maximum ap capacity of this node.",
      "type": "integer"
    },
    "switchCapacity": {
      "description": "maximum switch capacity of this node.",
      "type": "integer"
    },
    "totalApCapacity": {
      "description": "maximum total ap capacity of this node.",
      "type": "integer"
    },
    "totalSwitchCapacity": {
      "description": "maximum total switch capacity of this node.",
      "type": "integer"
    },
    "totalRemainingApCapacity": {
      "description": "total remaining ap capacity of this node.",
      "type": "integer"
    },
    "totalRemainingSwitchCapacity": {
      "description": "total remaining switch capacity of this node.",
      "type": "integer"
    },
    "aps": {
      "description": "connected aps in this node.",
      "type": "integer"
    },
    "dualRadioAps": {
      "description": "connected Aps with dual radios type",
      "type": "integer"
    },
    "triRadioAps": {
      "description": "connected Aps with three radios type",
      "type": "integer"
    },
    "switches": {
      "description": "connected switches in this node.",
      "type": "integer"
    },
    "totalAps": {
      "description": "total connected aps in the cluster.",
      "type": "integer"
    },
    "totalSwitches": {
      "description": "total connected switches in the cluster.",
      "type": "integer"
    },
    "totalRemainingDps": {
      "description": "total remaining DPs of the cluster.",
      "type": "integer"
    },
    "totalConnectedDps": {
      "description": "total connected DPs in the cluster.",
      "type": "integer"
    },
    "totalDpCapacity": {
      "description": "maximum total DP capacity of the cluster.",
      "type": "integer"
    }
  }
}

System Summary

GET/v11_1/controller

Use this API command to retrieve the system summary.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "b42be2c8-71bf-465a-8fd2-3911dcf885e4",
      "model": "SCG200",
      "description": "gui96-scg200-vm",
      "hostName": "gui96-scg200-vm",
      "mac": "00:0C:29:B1:34:69",
      "serialNumber": "00000096",
      "clusterRole": "Follower",
      "controlNatIp": null,
      "uptimeInSec": 165561,
      "name": "gui96-scg200-vm-C",
      "version": "3.0.0.0.211",
      "cpVersion": "3.0.0.0.543",
      "dpVersion": "3.0.0.0.56",
      "apVersion": "3.0.0.0.125",
      "controlIp": "172.18.114.29",
      "dataIp": null,
      "reservedPorts": {
        "rawDataTotalCount": 0,
        "totalCount": 2,
        "hasMore": false,
        "firstIndex": 0,
        "list": [
          {
            "port": "INBOUND",
            "portNumber": "21",
            "bindingInterface": "Control, Cluster, Management",
            "destination": "",
            "protocol": "TCP",
            "from": "System",
            "description": "FTP"
          },
          {
            "port": "OUTBOUND",
            "portNumber": "443",
            "bindingInterface": "Control, Cluster, Management",
            "destination": "*",
            "protocol": "TCP",
            "from": "System",
            "description": "license on management and control interface services"
          }
        ],
        "extra": null
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the controller",
            "type": "string"
          },
          "model": {
            "description": "Product model",
            "type": "string"
          },
          "description": {
            "description": "Description of the controller",
            "type": "string"
          },
          "hostName": {
            "description": "Host name of the controller",
            "type": "string"
          },
          "mac": {
            "description": "MAC address of the controller",
            "type": "string"
          },
          "serialNumber": {
            "description": "Serial number of the controller",
            "type": "string"
          },
          "clusterRole": {
            "description": "Indicator the role of the controller",
            "type": "string"
          },
          "controlNatIp": {
            "description": "Control NAT IP address settings",
            "type": "string"
          },
          "uptimeInSec": {
            "description": "Uptime (in seconds) of the controller",
            "type": "integer"
          },
          "name": {
            "description": "Name of the controller",
            "type": "string"
          },
          "version": {
            "description": "SCG version",
            "type": "string"
          },
          "cpVersion": {
            "description": "Control plane version",
            "type": "string"
          },
          "dpVersion": {
            "description": "Data plane version",
            "type": "string"
          },
          "apVersion": {
            "description": "AP version",
            "type": "string"
          },
          "controlIp": {
            "description": "Control IP",
            "type": "string"
          },
          "controlIpv6": {
            "description": "Control IPv6",
            "type": "string"
          },
          "dataIp": {
            "type": "string"
          },
          "reservedPorts": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "trafficDirection": {
                  "description": "Inbound/Outbound",
                  "type": "string"
                },
                "portRange": {
                  "description": "Reserved port range for SZ service",
                  "type": "string"
                },
                "bindingInterface": {
                  "description": "The binding interfaces, [\"Control\", \"Cluster\", \"Management\"]",
                  "type": "string"
                },
                "destination": {
                  "description": "The traffic destination (IP Address)",
                  "type": "string"
                },
                "protocol": {
                  "description": "TCP/UDP",
                  "type": "string"
                },
                "from": {
                  "description": "Rule from System or User",
                  "type": "string"
                },
                "description": {
                  "description": "The purpose of reserved port range",
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Retrieve security setting

GET/v11_1/system/securitySetting

Use this API command to retrieve the security setting.

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "captchaEnabled": {
      "description": "Captcha setting",
      "type": "boolean"
    },
    "maxInteractiveConcurrentSessions": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 3,
      "maximum": 10
    },
    "maxPublicApiConcurrentSessions": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 64,
      "maximum": 2048
    },
    "absoluteSessionTimeout": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "maximum": 1440
    },
    "sshAuthMethod": {
      "description": "SSH authentication method",
      "type": "string",
      "enum": [
        "PASSWORD",
        "PUBLICKEY",
        "PUBLICKEY_AND_PASSWORD",
        "PUBLICKEY_OR_PASSWORD"
      ]
    }
  }
}

Retrieve SZ Cloud Option Settings

GET/v11_1/system/cloudOptions

Use this API command to retrieve SZ Cloud Options settings.

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apCloudOnboardingEnabled": {
      "type": "boolean"
    },
    "isRuckusCloudOnboarded": {
      "type": "boolean"
    }
  }
}

Get Settings of System

GET/v11_1/system

Use this API command to get settings of system. Currently, Only can get settings about AP number limit.

Response  200
HideShow
Body
{
  "apNumberLimitEnabled": true,
  "apNumberLimitSettingsOfDomain": [
    {
      "domainId": "0a782052-96d5-738b-afce-123deeeswfgf",
      "domainName": "SystemAdmin",
      "numberLimit": 1000,
      "shared": false
    },
    {
      "domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
      "domainName": "domain111",
      "numberLimit": 123,
      "shared": false
    }
  ],
  "apNumberLimitSettingsOfZone": [
    {
      "domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
      "domainName": "domain111",
      "zoneId": "f77a8816-3049-40cd-8484-82919275ddc3",
      "zoneName": "zone11",
      "numberLimit": 123,
      "shared": true
    }
  ],
  "apMacOUIEnabled": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apNumberLimitEnabled": {
      "description": "Enabled AP number limit feature or not",
      "type": "boolean"
    },
    "apNumberLimitSettingsOfDomain": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "domainName": {
            "description": "Domain Name",
            "type": "string"
          },
          "numberLimit": {
            "description": "Number of Limit",
            "type": "integer",
            "format": "int64"
          },
          "shared": {
            "description": "Share mode",
            "type": "boolean"
          }
        }
      }
    },
    "apNumberLimitSettingsOfZone": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "domainId": {
            "description": "Admin Domain Id",
            "type": "string"
          },
          "domainName": {
            "description": "Admin Domain Name",
            "type": "string"
          },
          "zoneId": {
            "description": "Zone Id",
            "type": "string"
          },
          "zoneName": {
            "description": "Zone Name",
            "type": "string"
          },
          "numberLimit": {
            "description": "Number of Limit",
            "type": "integer",
            "format": "int64"
          },
          "shared": {
            "description": "Share mode",
            "type": "boolean"
          }
        }
      }
    },
    "apMacOUIEnabled": {
      "description": "Enabled AP Mac OUI feature or no",
      "type": "boolean"
    }
  }
}

AP Models

GET/v11_1/system/apmodels

Use this API command to retrieve support AP models for the current installed SZ version’s default AP firmware.

Response  200

AP Models by firmware version

GET/v11_1/system/apmodels/{firmwareVersion:.+}

Use this API command to retrieve support AP models from input firmware version.

Response  200

System Statistics

GET/v11_1/controller/{id}/statistics

Use this API command to retrieve the system statistics.

URI Parameters
HideShow
interval
string (optional) 

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

size
number (optional) 

Size, list size to response. Default: 32

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

System Inventory

GET/v11_1/system/inventory

Use this API command to retrieve the system inventory with current logon user domain.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "zoneId": "f77a8816-3049-40cd-8484-82919275ddc3",
      "zoneName": "Default 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,
      "apFirmwareVersion": "5.1.0.99.144",
      "meshEnabled": 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": {
          "zoneId": {
            "type": "string"
          },
          "zoneName": {
            "type": "string"
          },
          "meshSSID": {
            "type": "string"
          },
          "totalAPs": {
            "type": "integer"
          },
          "discoveryAPs": {
            "type": "integer"
          },
          "provisionedAPs": {
            "type": "integer"
          },
          "connectedAPs": {
            "type": "integer"
          },
          "disconnectedAPs": {
            "type": "integer"
          },
          "rebootingAPs": {
            "type": "integer"
          },
          "connectedRootAPs": {
            "type": "integer"
          },
          "disconnectedRootAPs": {
            "type": "integer"
          },
          "rebootingRootAPs": {
            "type": "integer"
          },
          "connectedMeshAPs": {
            "type": "integer"
          },
          "disconnectedMeshAPs": {
            "type": "integer"
          },
          "rebootingMeshAPs": {
            "type": "integer"
          },
          "connectedeMeshAPs": {
            "type": "integer"
          },
          "disconnectedeMeshAPs": {
            "type": "integer"
          },
          "rebootingeMeshAPs": {
            "type": "integer"
          },
          "connectedDownMeshAPs": {
            "type": "integer"
          },
          "disconnectedDownMeshAPs": {
            "type": "integer"
          },
          "rebootingDownMeshAPs": {
            "type": "integer"
          },
          "connectedMeshDisabledAPs": {
            "type": "integer"
          },
          "disconnectedMeshDisabledAPs": {
            "type": "integer"
          },
          "clients": {
            "type": "integer"
          },
          "apFirmwareVersion": {
            "type": "string"
          },
          "meshEnabled": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Retrieve AP Auto Approve Policy

GET/v11_1/system/apSettings/approval

Retrieve AP Auto Approve Policy.

Response  200
HideShow
Body
{
  "approveEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "approveEnabled": {
      "description": "enable automatically approve all join requests from APs",
      "type": "boolean"
    }
  }
}

Retrieve NBI

GET/v11_1/system/nbi

Use this API command to retrieve user information by Northbound Portal Interface.

URI Parameters
HideShow
domainId
string (optional) 

Domain ID.

Response  200
HideShow
Body
{
  "userName": "admin",
  "password": "admin!234",
  "radiusAuthType": "PAP"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "userName" : {
            "description" : "User name of the Northbound Interface",
            "type" : "string",
            "maxLength" : 64,
            "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
        },
        "password" : {
            "description" : "Password of the Northbound Interface",
            "type" : "string",
            "maxLength" : 64,
            "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
        },
        "radiusAuthType" : {
            "description" : "AuthType of the Radius used in Northbound Interface, the value should be \"PAP\" or \"CHAP\".",
            "type" : "string",
            "enum" : [ "PAP", "CHAP" ]
        }
    }
}

Retrieve System Time

GET/v11_1/system/systemTime

Retrieve System Time Setting.

Response  200
HideShow
Body
{
  "currentSystemTimeString": "2017-06-08 15:11:25 CST",
  "currentSystemTimeUTCString": "2017-06-08 07:11:25 UTC",
  "ntpServer": "ntp.ruckuswireless.com",
  "timezone": "Asia/Taipei"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "currentSystemTimeString": {
      "description": "System Time",
      "type": "string"
    },
    "currentSystemTimeUTCString": {
      "description": "System UTC Time",
      "type": "string"
    },
    "ntpServer": {
      "description": "Primary NtpServer address",
      "type": "string"
    },
    "secondaryNtpServer": {
      "description": "Secondary NtpServer address",
      "type": "string"
    },
    "thirdNtpServer": {
      "description": "Third NtpServer address",
      "type": "string"
    },
    "timezone": {
      "description": "System defined time zone, please refer to the 'Overview > Time Zone' list",
      "type": "string"
    },
    "authenticationKey": {
      "description": "The information to pass in when the NTP server requires authentication",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "keyId": {
          "description": "Authentication Key ID",
          "type": "integer"
        },
        "key": {
          "description": "Authentication Key value",
          "type": "string"
        },
        "keyType": {
          "description": "Authentication Key Type",
          "type": "string",
          "enum": [
            "SHA1",
            "MD5"
          ]
        }
      }
    },
    "secondaryAuthenticationKey": {
      "description": "The information to pass in when the secondary NTP server requires authentication",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "keyId": {
          "description": "Authentication Key ID",
          "type": "integer"
        },
        "key": {
          "description": "Authentication Key value",
          "type": "string"
        },
        "keyType": {
          "description": "Authentication Key Type",
          "type": "string",
          "enum": [
            "SHA1",
            "MD5"
          ]
        }
      }
    },
    "thirdAuthenticationKey": {
      "description": "The information to pass in when the third NTP server requires authentication",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "keyId": {
          "description": "Authentication Key ID",
          "type": "integer"
        },
        "key": {
          "description": "Authentication Key value",
          "type": "string"
        },
        "keyType": {
          "description": "Authentication Key Type",
          "type": "string",
          "enum": [
            "SHA1",
            "MD5"
          ]
        }
      }
    }
  }
}

Retrieve a list of AP Mac OUIs.

GET/v11_1/system/apMacOUIs

Use this API command to retrieve a list of AP Mac OUIs.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "oui": "11:22:33",
      "description": "description33"
    },
    {
      "oui": "11:22:44",
      "description": "description44"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total AP MAC OUI count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more AP MAC OUIs after the list that is currently displayed",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first AP MAC OUI returned out of the complete AP MAC OUI list",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "oui": {
            "description": "Organizationally unique identifier",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){2}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "description": {
            "description": "Description",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          }
        }
      }
    }
  }
}

Retrieve common access card settings

GET/v11_1/system/commonAccessCardSettings

Use this API command to retrieve common access card settings.

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "cacAuthEnabled": {
      "type": "boolean"
    },
    "cacAuthOcspServerUri": {
      "type": "string"
    },
    "cacAuthRootCACertificate": {
      "description": "The Trusted CA Certificate profile UUID for CAC Login",
      "type": "string"
    },
    "cacAuthUserName": {
      "type": "string",
      "enum": [
        "RFC822",
        "UPN"
      ]
    },
    "cacAuthAaaServer": {
      "description": "The Admin AAA profile UUID for CAC Login",
      "type": "string"
    }
  }
}

Validate NTP server

POST/v11_1/globalSettings/systemTime/validate

Use this API command to validate a NTP server.

Request
HideShow
Body
{
  "ntpServer": "10.2.3.4",
  "authenticationKey": {
    "key": "ruckus1!",
    "keyId": 1,
    "keyType": "SHA1"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ntpServer": {
      "description": "NTP Server address for validation",
      "type": "string"
    },
    "authenticationKey": {
      "description": "NTP server Authentication Key for validation",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "keyId": {
          "description": "Authentication Key ID",
          "type": "integer"
        },
        "key": {
          "description": "Authentication Key value",
          "type": "string"
        },
        "keyType": {
          "description": "Authentication Key Type",
          "type": "string",
          "enum": [
            "SHA1",
            "MD5"
          ]
        }
      }
    }
  },
  "required": [
    "ntpServer"
  ]
}
Response  200
HideShow
Body
{
  "message": "NTP 10.2.3.4 is unreachable"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "message": {
      "description": "NTP Server Validation Message",
      "type": "string"
    }
  }
}

Execute ap balance

POST/v11_1/system/ap_balance

Execute ap balance.

Response  200

Create AP Mac OUI.

POST/v11_1/system/apMacOUIs

Use this API command to create AP Mac OUI.

Request
HideShow
Body
{
  "oui": "11:22:33",
  "description": "description33"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "oui": {
      "description": "Organizationally unique identifier",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){2}([0-9a-fA-F][0-9a-fA-F])$"
    },
    "description": {
      "description": "Description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    }
  },
  "required": [
    "oui"
  ]
}
Response  204

Modify security setting

PUT/v11_1/system/securitySetting

Use this API command to retrieve the security setting.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "captchaEnabled": {
      "description": "Captcha setting",
      "type": "boolean"
    },
    "maxInteractiveConcurrentSessions": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 3,
      "maximum": 10
    },
    "maxPublicApiConcurrentSessions": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 64,
      "maximum": 2048
    },
    "absoluteSessionTimeout": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "maximum": 1440
    },
    "sshAuthMethod": {
      "description": "SSH authentication method",
      "type": "string",
      "enum": [
        "PASSWORD",
        "PUBLICKEY",
        "PUBLICKEY_AND_PASSWORD",
        "PUBLICKEY_OR_PASSWORD"
      ]
    }
  }
}
Response  200

Modify SZ Cloud Option Settings

PUT/v11_1/system/cloudOptions

Use this API command to modify SZ Cloud Options settings.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apCloudOnboardingEnabled": {
      "type": "boolean"
    },
    "isRuckusCloudOnboarded": {
      "type": "boolean"
    }
  }
}
Response  200

Update AP Mac OUI.

PUT/v11_1/system/apMacOUIs/{OUI}

Use this API command to update AP Mac OUI.

Request
HideShow
Body
{
  "description": "description11"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "description": {
      "description": "Description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    }
  }
}
Response  204

Modify common access card settings

PUT/v11_1/system/commonAccessCardSettings

Use this API command to retrieve common access card settings.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "cacAuthEnabled": {
      "type": "boolean"
    },
    "cacAuthOcspServerUri": {
      "type": "string"
    },
    "cacAuthRootCACertificate": {
      "description": "The Trusted CA Certificate profile UUID for CAC Login",
      "type": "string"
    },
    "cacAuthUserName": {
      "type": "string",
      "enum": [
        "RFC822",
        "UPN"
      ]
    },
    "cacAuthAaaServer": {
      "description": "The Admin AAA profile UUID for CAC Login",
      "type": "string"
    }
  }
}
Response  204

Modify Settings of System

PATCH/v11_1/system

Use this API command to modify settings of system. Currently, Only can modify settings about AP number limit by query criteria with domain and zone filters.

Request
HideShow
Body
{
  "apNumberLimitEnabled": true,
  "apNumberLimitSettingsOfDomain": [
    {
      "domainId": "0a782052-96d5-738b-afce-123deeeswfgf",
      "domainName": "SystemAdmin",
      "numberLimit": 1000,
      "shared": false
    },
    {
      "domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
      "domainName": "domain111",
      "numberLimit": 123,
      "shared": false
    }
  ],
  "apNumberLimitSettingsOfZone": [
    {
      "domainId": "0a782052-96d5-738b-afce-aa8157abd30c",
      "domainName": "domain111",
      "zoneId": "f77a8816-3049-40cd-8484-82919275ddc3",
      "zoneName": "zone11",
      "numberLimit": 123,
      "shared": true
    }
  ],
  "apMacOUIEnabled": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apNumberLimitEnabled": {
      "description": "Enabled AP number limit feature or not",
      "type": "boolean"
    },
    "apNumberLimitSettingsOfDomain": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "domainName": {
            "description": "Domain Name",
            "type": "string"
          },
          "numberLimit": {
            "description": "Number of Limit",
            "type": "integer",
            "format": "int64"
          },
          "shared": {
            "description": "Share mode",
            "type": "boolean"
          }
        }
      }
    },
    "apNumberLimitSettingsOfZone": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "domainId": {
            "description": "Admin Domain Id",
            "type": "string"
          },
          "domainName": {
            "description": "Admin Domain Name",
            "type": "string"
          },
          "zoneId": {
            "description": "Zone Id",
            "type": "string"
          },
          "zoneName": {
            "description": "Zone Name",
            "type": "string"
          },
          "numberLimit": {
            "description": "Number of Limit",
            "type": "integer",
            "format": "int64"
          },
          "shared": {
            "description": "Share mode",
            "type": "boolean"
          }
        }
      }
    },
    "apMacOUIEnabled": {
      "description": "Enabled AP Mac OUI feature or no",
      "type": "boolean"
    }
  }
}
Response  204

Modify AP Auto Approve Policy

PATCH/v11_1/system/apSettings/approval

Modify AP Auto Approve Policy.

Request
HideShow
Body
{
  "approveEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "approveEnabled": {
      "description": "enable automatically approve all join requests from APs",
      "type": "boolean"
    }
  }
}
Response  204

Modify NBI Basic

PATCH/v11_1/system/nbi

Use this API command to modify the user information by Northbound Portal Interface.

URI Parameters
HideShow
domainId
string (optional) 

Domain ID.

Request
HideShow
Body
{
  "userName": "admin",
  "password": "admin!234",
  "radiusAuthType": "PAP"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "userName" : {
            "description" : "User name of the Northbound Interface",
            "type" : "string",
            "maxLength" : 64,
            "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
        },
        "password" : {
            "description" : "Password of the Northbound Interface",
            "type" : "string",
            "maxLength" : 64,
            "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
        },
        "radiusAuthType" : {
            "description" : "AuthType of the Radius used in Northbound Interface, the value should be \"PAP\" or \"CHAP\".",
            "type" : "string",
            "enum" : [ "PAP", "CHAP" ]
        }
    }
}
Response  204

Modify System Time

PATCH/v11_1/system/systemTime

Modify System Time Setting.

Request
HideShow
Body
{
  "ntpServer": "ntp.ruckuswireless.com",
  "timezone": "Asia/Taipei"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ntpServer": {
      "description": "Primary NtpServer address",
      "type": "string"
    },
    "secondaryNtpServer": {
      "description": "Secondary NtpServer address",
      "type": "string"
    },
    "thirdNtpServer": {
      "description": "Third NtpServer address",
      "type": "string"
    },
    "timezone": {
      "description": "System defined time zone, please refer to the 'Overview > Time Zone' list",
      "type": "string"
    },
    "authenticationKey": {
      "description": "The information to pass in when the NTP server requires authentication",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "keyId": {
          "description": "Authentication Key ID",
          "type": "integer"
        },
        "key": {
          "description": "Authentication Key value",
          "type": "string"
        },
        "keyType": {
          "description": "Authentication Key Type",
          "type": "string",
          "enum": [
            "SHA1",
            "MD5"
          ]
        }
      }
    },
    "secondaryAuthenticationKey": {
      "description": "The information to pass in when the secondary NTP server requires authentication",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "keyId": {
          "description": "Authentication Key ID",
          "type": "integer"
        },
        "key": {
          "description": "Authentication Key value",
          "type": "string"
        },
        "keyType": {
          "description": "Authentication Key Type",
          "type": "string",
          "enum": [
            "SHA1",
            "MD5"
          ]
        }
      }
    },
    "thirdAuthenticationKey": {
      "description": "The information to pass in when the third NTP server requires authentication",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "keyId": {
          "description": "Authentication Key ID",
          "type": "integer"
        },
        "key": {
          "description": "Authentication Key value",
          "type": "string"
        },
        "keyType": {
          "description": "Authentication Key Type",
          "type": "string",
          "enum": [
            "SHA1",
            "MD5"
          ]
        }
      }
    }
  }
}
Response  204

Disable NBI

DELETE/v11_1/system/nbi

Use this API command to disable the user information by Northbound Portal Interface.

URI Parameters
HideShow
domainId
string (optional) 

Domain ID.

Response  204

Delete AP Mac OUI.

DELETE/v11_1/system/apMacOUIs/{OUI}

Use this API command to delete AP Mac OUI.

Response  204

Test AAA Server

Test AAA

POST/v11_1/system/aaa/test

Use this API command to test AAA server.

Request
HideShow
Body
{
  "serverType": "GLOBAL",
  "aaaType": "RADIUS",
  "aaaServer": {
    "name": "apiAAAServer"
  },
  "userName": "admin",
  "password": "admin!234",
  "authProtocol": "CHAP"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "serverType": {
      "description": "Radius server type.",
      "type": "string",
      "enum": [
        "ADMIN",
        "GLOBAL",
        "ZONE"
      ]
    },
    "aaaType": {
      "description": "Authentication/Accounting service protocol. RADIUS for Radius, AD and LDAP. RADIUSAcct for RADIUS Accounting",
      "type": "string",
      "enum": [
        "RADIUS",
        "RADIUSAcct"
      ]
    },
    "aaaServer": {
      "description": "AAA server id or name",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "userName": {
      "description": "User name",
      "type": "string"
    },
    "password": {
      "description": "Password",
      "type": "string"
    },
    "authProtocol": {
      "description": "Authentication protocol",
      "type": "string",
      "enum": [
        "PAP",
        "CHAP",
        "PEAP"
      ],
      "default": "PAP"
    }
  },
  "required": [
    "aaaServer"
  ]
}
Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "aaaTesting": {
      "type": "string"
    }
  }
}

SNMP Agent

Retrieve SNMP Agent

GET/v11_1/system/snmpAgent

Retrieve SNMP Agent sertting.

Response  200
HideShow
Body
{
  "snmpNotificationEnabled": false,
  "snmpV2Agent": [
    {
      "communityName": "communityName",
      "readEnabled": false,
      "writeEnabled": false,
      "notificationEnabled": true,
      "notificationType": "TRAP",
      "notificationTarget": [
        {
          "address": "111.11.11.112",
          "port": 1
        },
        {
          "address": "111.11.11.114",
          "port": 162
        },
        {
          "address": "111.11.11.114",
          "port": 162
        }
      ]
    }
  ],
  "snmpV3Agent": [
    {
      "userName": "bbb",
      "authProtocol": "SHA",
      "authPassword": "authPassword",
      "readEnabled": true,
      "writeEnabled": true,
      "notificationEnabled": false
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "snmpNotificationEnabled": {
      "description": "Enable SNMP Notifications Globally (If SNMP Notification is disabled globally, no Notification message is sent out.)",
      "type": "boolean"
    },
    "snmpV2Agent": {
      "description": "Community List of the SNMP V2 Agent.",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "communityName": {
            "description": "name of the SNMP Community.",
            "type": "string"
          },
          "readEnabled": {
            "description": "read privilege of the SNMP Coummunity",
            "type": "boolean"
          },
          "writeEnabled": {
            "description": "write privilege of the SNMP Coummunity",
            "type": "boolean"
          },
          "notificationEnabled": {
            "description": "notification privilege of the SNMP Coummunity",
            "type": "boolean"
          },
          "notificationType": {
            "description": "type of the notification privilege",
            "type": "string",
            "enum": [
              "TRAP",
              "INFORM"
            ]
          },
          "notificationTarget": {
            "description": "Trap List of the SNMP Coummunity",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "address": {
                  "description": "address of the SNMP Trap",
                  "type": "string"
                },
                "port": {
                  "description": "port number of the SNMP Trap",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                }
              },
              "required": [
                "address",
                "port"
              ]
            }
          }
        },
        "required": [
          "communityName",
          "readEnabled",
          "writeEnabled",
          "notificationEnabled"
        ]
      }
    },
    "snmpV3Agent": {
      "description": "User List of the SNMP V2 Agent.",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "userName": {
            "description": "name of the SNMP User.",
            "type": "string"
          },
          "authProtocol": {
            "description": "authProtocol of the SNMP User.",
            "type": "string",
            "enum": [
              "MD5",
              "SHA"
            ]
          },
          "authPassword": {
            "description": "authPassword of the SNMP User.",
            "type": "string",
            "minLength": 8
          },
          "privProtocol": {
            "description": "privProtocol of the SNMP User.",
            "type": "string",
            "enum": [
              "DES",
              "AES"
            ]
          },
          "privPassword": {
            "description": "privPassword of the SNMP User.",
            "type": "string",
            "minLength": 8
          },
          "readEnabled": {
            "description": "read privilege of the SNMP User",
            "type": "boolean"
          },
          "writeEnabled": {
            "description": "write privilege of the SNMP User",
            "type": "boolean"
          },
          "notificationEnabled": {
            "description": "notification privilege of the SNMP User",
            "type": "boolean"
          },
          "notificationType": {
            "description": "type of the notification privilege",
            "type": "string",
            "enum": [
              "TRAP",
              "INFORM"
            ]
          },
          "notificationTarget": {
            "description": "Trap List of the SNMP User",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "address": {
                  "description": "address of the SNMP Trap",
                  "type": "string"
                },
                "port": {
                  "description": "port number of the SNMP Trap",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                }
              },
              "required": [
                "address",
                "port"
              ]
            }
          }
        },
        "required": [
          "userName"
        ]
      }
    }
  }
}

Modify SNMP Agent

PUT/v11_1/system/snmpAgent

Modify syslog server setting.

Request
HideShow
Body
{
  "snmpNotificationEnabled": true,
  "snmpV2Agent": [
    {
      "communityName": "aaa",
      "readEnabled": false,
      "writeEnabled": false,
      "notificationEnabled": true,
      "notificationType": "TRAP",
      "notificationTarget": [
        {
          "address": "111.11.11.112",
          "port": 1
        },
        {
          "address": "111.11.11.114",
          "port": 162
        },
        {
          "address": "111.11.11.114",
          "port": 162
        }
      ]
    }
  ],
  "snmpV3Agent": [
    {
      "userName": "userName",
      "authProtocol": "SHA",
      "authPassword": "authPassword",
      "privProtocol": "DES",
      "privPassword": "privPassword",
      "readEnabled": true,
      "writeEnabled": true,
      "notificationEnabled": true,
      "notificationType": "TRAP",
      "notificationTarget": [
        {
          "address": "111.11.11.112",
          "port": 1
        },
        {
          "address": "111.11.11.114",
          "port": 162
        },
        {
          "address": "111.11.11.114",
          "port": 162
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "snmpNotificationEnabled": {
      "description": "Enable SNMP Notifications Globally (If SNMP Notification is disabled globally, no Notification message is sent out.)",
      "type": "boolean"
    },
    "snmpV2Agent": {
      "description": "Community List of the SNMP V2 Agent.",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "communityName": {
            "description": "name of the SNMP Community.",
            "type": "string"
          },
          "readEnabled": {
            "description": "read privilege of the SNMP Coummunity",
            "type": "boolean"
          },
          "writeEnabled": {
            "description": "write privilege of the SNMP Coummunity",
            "type": "boolean"
          },
          "notificationEnabled": {
            "description": "notification privilege of the SNMP Coummunity",
            "type": "boolean"
          },
          "notificationType": {
            "description": "type of the notification privilege",
            "type": "string",
            "enum": [
              "TRAP",
              "INFORM"
            ]
          },
          "notificationTarget": {
            "description": "Trap List of the SNMP Coummunity",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "address": {
                  "description": "address of the SNMP Trap",
                  "type": "string"
                },
                "port": {
                  "description": "port number of the SNMP Trap",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                }
              },
              "required": [
                "address",
                "port"
              ]
            }
          }
        },
        "required": [
          "communityName",
          "readEnabled",
          "writeEnabled",
          "notificationEnabled"
        ]
      }
    },
    "snmpV3Agent": {
      "description": "User List of the SNMP V2 Agent.",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "userName": {
            "description": "name of the SNMP User.",
            "type": "string"
          },
          "authProtocol": {
            "description": "authProtocol of the SNMP User.",
            "type": "string",
            "enum": [
              "MD5",
              "SHA"
            ]
          },
          "authPassword": {
            "description": "authPassword of the SNMP User.",
            "type": "string",
            "minLength": 8
          },
          "privProtocol": {
            "description": "privProtocol of the SNMP User.",
            "type": "string",
            "enum": [
              "DES",
              "AES"
            ]
          },
          "privPassword": {
            "description": "privPassword of the SNMP User.",
            "type": "string",
            "minLength": 8
          },
          "readEnabled": {
            "description": "read privilege of the SNMP User",
            "type": "boolean"
          },
          "writeEnabled": {
            "description": "write privilege of the SNMP User",
            "type": "boolean"
          },
          "notificationEnabled": {
            "description": "notification privilege of the SNMP User",
            "type": "boolean"
          },
          "notificationType": {
            "description": "type of the notification privilege",
            "type": "string",
            "enum": [
              "TRAP",
              "INFORM"
            ]
          },
          "notificationTarget": {
            "description": "Trap List of the SNMP User",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "address": {
                  "description": "address of the SNMP Trap",
                  "type": "string"
                },
                "port": {
                  "description": "port number of the SNMP Trap",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                }
              },
              "required": [
                "address",
                "port"
              ]
            }
          }
        },
        "required": [
          "userName"
        ]
      }
    }
  },
  "required": [
    "snmpNotificationEnabled"
  ]
}
Response  204

Domain

Retrieve Domain List by Domain Name

GET/v11_1/domains/byName/{domainName}

Use this API command to retrieve a list of domain by specified Domain name.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "domainUUID",
      "name": "testDomain_1",
      "domainType": "REGULAR",
      "description": null,
      "createdBy": "admin",
      "createDatetime": "2017/05/03 10:15:01",
      "parentDomainId": "parentDomainUUId",
      "zoneCount": 0,
      "subDomainCount": 0,
      "administratorCount": 0,
      "apCount": 0
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the domain",
            "type": "string"
          },
          "name": {
            "description": "domain name",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "domainType": {
            "description": "domain type",
            "type": "string"
          },
          "description": {
            "description": "Description of the domain",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "createdBy": {
            "description": "Created by",
            "type": "string"
          },
          "createDatetime": {
            "description": "Created by",
            "type": "string"
          },
          "zoneCount": {
            "description": "# of Zones",
            "type": "integer"
          },
          "subDomainCount": {
            "description": "# of Subdomains",
            "type": "integer"
          },
          "administratorCount": {
            "description": "# of Subdomains (Deprecated from v9 and will be removed on v12)",
            "type": "integer"
          },
          "apCount": {
            "description": "# of Subdomains",
            "type": "integer"
          },
          "parentDomainId": {
            "description": "Parent Domain Id",
            "type": "string"
          },
          "zeroTouchStatus": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Retrieve

GET/v11_1/domains/{id}

Use this API command to retrieve domain by specified Domain ID.

URI Parameters
HideShow
recursively
string (optional) 
Response  200
HideShow
Body
{
  "id": "domainUUID",
  "name": "testDomain_1",
  "domainType": "REGULAR",
  "description": null,
  "createdBy": "admin",
  "createDatetime": "2017/05/03 10:15:01",
  "parentDomainId": "parentDomainUUId",
  "zoneCount": 0,
  "subDomainCount": 0,
  "administratorCount": 0,
  "apCount": 0
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the domain",
      "type": "string"
    },
    "name": {
      "description": "domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "domainType": {
      "description": "domain type",
      "type": "string"
    },
    "description": {
      "description": "Description of the domain",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "createdBy": {
      "description": "Created by",
      "type": "string"
    },
    "createDatetime": {
      "description": "Created by",
      "type": "string"
    },
    "zoneCount": {
      "description": "# of Zones",
      "type": "integer"
    },
    "subDomainCount": {
      "description": "# of Subdomains",
      "type": "integer"
    },
    "administratorCount": {
      "description": "# of Subdomains (Deprecated from v9 and will be removed on v12)",
      "type": "integer"
    },
    "apCount": {
      "description": "# of Subdomains",
      "type": "integer"
    },
    "parentDomainId": {
      "description": "Parent Domain Id",
      "type": "string"
    },
    "zeroTouchStatus": {
      "type": "boolean"
    }
  }
}

Retrieve List

GET/v11_1/domains

Use this API command to retrieve a list of domain under Administration Domain.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

recursively
string (optional) 

Get domain list recursively.

includeSelf
string (optional) 

Get domain list include Self.

excludeRegularDomain
string (optional) 
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "domainUUID",
      "name": "testDomain_1",
      "domainType": "REGULAR",
      "description": null,
      "createdBy": "admin",
      "createDatetime": "2017/05/03 10:15:01",
      "parentDomainId": "parentDomainUUId",
      "zoneCount": 0,
      "subDomainCount": 0,
      "administratorCount": 0,
      "apCount": 0
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the domain",
            "type": "string"
          },
          "name": {
            "description": "domain name",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "domainType": {
            "description": "domain type",
            "type": "string"
          },
          "description": {
            "description": "Description of the domain",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "createdBy": {
            "description": "Created by",
            "type": "string"
          },
          "createDatetime": {
            "description": "Created by",
            "type": "string"
          },
          "zoneCount": {
            "description": "# of Zones",
            "type": "integer"
          },
          "subDomainCount": {
            "description": "# of Subdomains",
            "type": "integer"
          },
          "administratorCount": {
            "description": "# of Subdomains (Deprecated from v9 and will be removed on v12)",
            "type": "integer"
          },
          "apCount": {
            "description": "# of Subdomains",
            "type": "integer"
          },
          "parentDomainId": {
            "description": "Parent Domain Id",
            "type": "string"
          },
          "zeroTouchStatus": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Modify

PATCH/v11_1/domains/{id}

Use this API command to modify the configuration of domain.

Request
HideShow
Body
{
  "description": "testDomain"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "zeroTouchStatus": {
      "description": "Zero Touch enable/disable ",
      "type": "boolean"
    }
  }
}
Response  204

Syslog Server

Retrieve Syslog

GET/v11_1/system/syslog

Retrieve syslog server sertting.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "enabled": true,
  "appLogFacility": "Local1",
  "appLogSeverity": "Debug",
  "auditLogFacility": "Local2",
  "auditLogSeverity": "Debug",
  "eventLogFacility": "Local2",
  "otherLogSeverity": "Debug",
  "forwardUEEventsMsgFormatType": "COMMON",
  "eventFilter": 2,
  "eventFilterSeverity": "Debug",
  "primaryServer": {
    "host": "192.1.0.1",
    "port": 90,
    "protocol": "UDP"
  },
  "secondaryServer": {
    "host": "192.10.8.9",
    "port": 82,
    "protocol": "UDP",
    "redundancyMode": "primary_backup"
  },
  "priority": {
    "critical": "ERROR",
    "major": "ERROR",
    "minor": "WARN",
    "warning": "WARN",
    "informational": "INFO",
    "debug": "DEBUG"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "description": "enable logging to remote syslog server",
      "type": "boolean"
    },
    "appLogFacility": {
      "description": "appLogFacility: Local0-Local7",
      "type": "string"
    },
    "auditLogFacility": {
      "description": "auditLogFacility: Local0-Local7",
      "type": "string"
    },
    "eventLogFacility": {
      "description": "auditLogFacility: Local0-Local7",
      "type": "string"
    },
    "appLogSeverity": {
      "description": "appLogSeverity: Emerg, Alert, Crit, Error, Warning, Notice, Info, Debug",
      "type": "string"
    },
    "auditLogSeverity": {
      "description": "auditLogSeverity: Emerg, Alert, Crit, Error, Warning, Notice, Info, Debug",
      "type": "string"
    },
    "otherLogSeverity": {
      "description": "otherLogSeverity: Emerg, Alert, Crit, Error, Warning, Notice, Info, Debug",
      "type": "string"
    },
    "forwardUEEventsMsgFormatType": {
      "description": "forwardUEEventsMsgFormatType : COMMON, ZD",
      "type": "string"
    },
    "primaryServer": {
      "description": "The primary server settings of syslog server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "host": {
          "description": "address of the syslog server.",
          "type": "string"
        },
        "port": {
          "description": "port number of the syslog server",
          "type": "integer"
        },
        "protocol": {
          "description": "protocol of the syslog server",
          "type": "string",
          "enum": [
            "UDP",
            "TCP"
          ]
        }
      }
    },
    "secondaryServer": {
      "description": "The secondary server settings of syslog server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "host": {
          "description": "address of the syslog server.",
          "type": "string"
        },
        "port": {
          "description": "port number of the syslog server",
          "type": "integer"
        },
        "protocol": {
          "description": "protocol of the syslog server",
          "type": "string",
          "enum": [
            "UDP",
            "TCP"
          ]
        },
        "redundancyMode": {
          "description": "The redundancy mode of syslog server",
          "type": "string",
          "enum": [
            "active_active",
            "primary_backup"
          ]
        }
      }
    },
    "eventFilter": {
      "description": "Event Filter, 0 : All events, 1 : All events except client association/disassociation events, 2 : All events above a severity",
      "type": "integer",
      "minimum": 0,
      "maximum": 2
    },
    "eventFilterSeverity": {
      "description": "Event Filter Severity, This only applies when the Event Filter is set to 2",
      "type": "string",
      "enum": [
        "Critical",
        "Major",
        "Minor",
        "Warning",
        "Informational",
        "Debug"
      ]
    },
    "priority": {
      "description": "Priority",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "critical": {
          "description": "Event severity",
          "type": "string",
          "enum": [
            "ERROR",
            "WARN",
            "INFO",
            "DEBUG"
          ]
        },
        "major": {
          "description": "Event severity",
          "type": "string",
          "enum": [
            "ERROR",
            "WARN",
            "INFO",
            "DEBUG"
          ]
        },
        "minor": {
          "description": "Event severity",
          "type": "string",
          "enum": [
            "ERROR",
            "WARN",
            "INFO",
            "DEBUG"
          ]
        },
        "warning": {
          "description": "Event severity",
          "type": "string",
          "enum": [
            "ERROR",
            "WARN",
            "INFO",
            "DEBUG"
          ]
        },
        "informational": {
          "description": "Event severity",
          "type": "string",
          "enum": [
            "ERROR",
            "WARN",
            "INFO",
            "DEBUG"
          ]
        },
        "debug": {
          "description": "Event severity",
          "type": "string",
          "enum": [
            "ERROR",
            "WARN",
            "INFO",
            "DEBUG"
          ]
        }
      }
    }
  }
}

Modify Syslog

PATCH/v11_1/system/syslog

Modify syslog server setting.

Request
HideShow
Body
{
  "enabled": true,
  "appLogFacility": "Local1",
  "appLogSeverity": "Debug",
  "auditLogFacility": "Local2",
  "auditLogSeverity": "Debug",
  "eventLogFacility": "Local2",
  "otherLogSeverity": "Debug",
  "forwardUEEventsMsgFormatType": "COMMON",
  "eventFilter": 2,
  "eventFilterSeverity": "Debug",
  "primaryServer": {
    "host": "192.1.0.1",
    "port": 90,
    "protocol": "UDP"
  },
  "secondaryServer": {
    "host": "192.10.8.9",
    "port": 82,
    "protocol": "UDP",
    "redundancyMode": "primary_backup"
  },
  "priority": {
    "critical": "ERROR",
    "major": "ERROR",
    "minor": "WARN",
    "warning": "WARN",
    "informational": "INFO",
    "debug": "DEBUG"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "description": "enable logging to remote syslog server",
      "type": "boolean"
    },
    "appLogFacility": {
      "description": "appLogFacility: Local0-Local7",
      "type": "string"
    },
    "auditLogFacility": {
      "description": "auditLogFacility: Local0-Local7",
      "type": "string"
    },
    "eventLogFacility": {
      "description": "Facility for Event",
      "type": "string"
    },
    "appLogSeverity": {
      "description": "appLogSeverity: Emerg, Alert, Crit, Error, Warning, Notice, Info, Debug",
      "type": "string"
    },
    "auditLogSeverity": {
      "description": "auditLogSeverity: Emerg, Alert, Crit, Error, Warning, Notice, Info, Debug",
      "type": "string"
    },
    "otherLogSeverity": {
      "description": "otherLogSeverity: Emerg, Alert, Crit, Error, Warning, Notice, Info, Debug",
      "type": "string"
    },
    "forwardUEEventsMsgFormatType": {
      "description": "forwardUEEventsMsgFormatType : COMMON, ZD",
      "type": "string"
    },
    "primaryServer": {
      "description": "The primary server settings of syslog server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "host": {
          "description": "address of the syslog server.",
          "type": "string"
        },
        "port": {
          "description": "port number of the syslog server",
          "type": "integer"
        },
        "protocol": {
          "description": "protocol of the syslog server",
          "type": "string",
          "enum": [
            "UDP",
            "TCP"
          ]
        }
      }
    },
    "secondaryServer": {
      "description": "The secondary server settings of syslog server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "host": {
          "description": "address of the syslog server.",
          "type": "string"
        },
        "port": {
          "description": "port number of the syslog server",
          "type": "integer"
        },
        "protocol": {
          "description": "protocol of the syslog server",
          "type": "string",
          "enum": [
            "UDP",
            "TCP"
          ]
        },
        "redundancyMode": {
          "description": "The redundancy mode of syslog server",
          "type": "string",
          "enum": [
            "active_active",
            "primary_backup"
          ]
        }
      }
    },
    "eventFilter": {
      "description": "Event Filter, 0 : All events, 1 : All events except client association/disassociation events, 2 : All events above a severity",
      "type": "integer",
      "minimum": 0,
      "maximum": 2
    },
    "eventFilterSeverity": {
      "description": "Event Filter Severity, This only applies when the Event Filter is set to 2",
      "type": "string",
      "enum": [
        "Critical",
        "Major",
        "Minor",
        "Warning",
        "Informational",
        "Debug"
      ]
    },
    "priority": {
      "description": "Priority",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "critical": {
          "description": "Event severity",
          "type": "string",
          "enum": [
            "ERROR",
            "WARN",
            "INFO",
            "DEBUG"
          ]
        },
        "major": {
          "description": "Event severity",
          "type": "string",
          "enum": [
            "ERROR",
            "WARN",
            "INFO",
            "DEBUG"
          ]
        },
        "minor": {
          "description": "Event severity",
          "type": "string",
          "enum": [
            "ERROR",
            "WARN",
            "INFO",
            "DEBUG"
          ]
        },
        "warning": {
          "description": "Event severity",
          "type": "string",
          "enum": [
            "ERROR",
            "WARN",
            "INFO",
            "DEBUG"
          ]
        },
        "informational": {
          "description": "Event severity",
          "type": "string",
          "enum": [
            "ERROR",
            "WARN",
            "INFO",
            "DEBUG"
          ]
        },
        "debug": {
          "description": "Event severity",
          "type": "string",
          "enum": [
            "ERROR",
            "WARN",
            "INFO",
            "DEBUG"
          ]
        }
      }
    }
  }
}
Response  204

Modify Primary Server

PATCH/v11_1/system/syslog/primaryServer

Modify Primary Server of syslog.

Request
HideShow
Body
{
  "host": "192.1.0.1",
  "port": 90,
  "protocol": "UDP"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "host": {
      "description": "address of the syslog server.",
      "type": "string"
    },
    "port": {
      "description": "port number of the syslog server",
      "type": "integer"
    },
    "protocol": {
      "description": "protocol of the syslog server",
      "type": "string",
      "enum": [
        "UDP",
        "TCP"
      ]
    }
  }
}
Response  204

Modify Secondary Server

PATCH/v11_1/system/syslog/secondaryServer

Modify Secondary Server of syslog.

Request
HideShow
Body
{
  "host": "192.10.8.9",
  "port": 82,
  "protocol": "UDP",
  "redundancyMode": "primary_backup"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "host": {
      "description": "address of the syslog server.",
      "type": "string"
    },
    "port": {
      "description": "port number of the syslog server",
      "type": "integer"
    },
    "protocol": {
      "description": "protocol of the syslog server",
      "type": "string",
      "enum": [
        "UDP",
        "TCP"
      ]
    },
    "redundancyMode": {
      "description": "The redundancy mode of syslog server",
      "type": "string",
      "enum": [
        "active_active",
        "primary_backup"
      ]
    }
  }
}
Response  204

Modify Priority

PATCH/v11_1/system/syslog/priority

Modify Priority of syslog.

Request
HideShow
Body
{
  "critical": "ERROR",
  "major": "ERROR",
  "minor": "WARN",
  "warning": "WARN",
  "informational": "INFO",
  "debug": "DEBUG"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "critical": {
      "description": "Event severity",
      "type": "string",
      "enum": [
        "ERROR",
        "WARN",
        "INFO",
        "DEBUG"
      ]
    },
    "major": {
      "description": "Event severity",
      "type": "string",
      "enum": [
        "ERROR",
        "WARN",
        "INFO",
        "DEBUG"
      ]
    },
    "minor": {
      "description": "Event severity",
      "type": "string",
      "enum": [
        "ERROR",
        "WARN",
        "INFO",
        "DEBUG"
      ]
    },
    "warning": {
      "description": "Event severity",
      "type": "string",
      "enum": [
        "ERROR",
        "WARN",
        "INFO",
        "DEBUG"
      ]
    },
    "informational": {
      "description": "Event severity",
      "type": "string",
      "enum": [
        "ERROR",
        "WARN",
        "INFO",
        "DEBUG"
      ]
    },
    "debug": {
      "description": "Event severity",
      "type": "string",
      "enum": [
        "ERROR",
        "WARN",
        "INFO",
        "DEBUG"
      ]
    }
  }
}
Response  204

Control Planes

Retrieve

GET/v11_1/enterprise/controlPlanes/{bladeUUID}

Use this API command to retrieve control plane.

Response  200
HideShow
Body
{
  "ipMode": "STATIC",
  "ipAddress": "10.2.3.96",
  "subnetMask": "255.255.0.0",
  "gateway": "10.2.0.1",
  "primaryDNSServer": "172.17.17.16"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ipMode": {
      "description": "IP support version",
      "type": "string",
      "enum": [
        "STATIC",
        "DHCP"
      ]
    },
    "gateway": {
      "type": "string"
    },
    "ipAddress": {
      "type": "string"
    },
    "natIp": {
      "type": "string"
    },
    "primaryDNSServer": {
      "type": "string"
    },
    "secondaryDNSServer": {
      "type": "string"
    },
    "subnetMask": {
      "type": "string"
    }
  }
}

Retrieve List

GET/v11_1/enterprise/controlPlanes

Use this API command to retrieve the list of control plane.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "cc2ae3a2-8221-4bd3-a5c2-bfed116f07c6",
      "clusterNode": "jack-sz100-ml36",
      "description": "Automatic installed jack-sz100-ml36",
      "model": "SZ124",
      "serialNumber": "00000089",
      "numOfAps": 1,
      "macAddress": "11:22:33:88:44:22",
      "mntIp": "0.0.0.0",
      "clusterRole": "Leader",
      "upTime": "8.0d "
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the control plane",
            "type": "string"
          },
          "model": {
            "description": "Model",
            "type": "string"
          },
          "serialNumber": {
            "description": "Serial Number",
            "type": "string"
          },
          "numOfAps": {
            "description": "Total Connected APs",
            "type": "string"
          },
          "description": {
            "description": "Description",
            "type": "string"
          },
          "clusterRole": {
            "description": "Cluster Role",
            "type": "string"
          },
          "upTime": {
            "description": "Uptime",
            "type": "string"
          },
          "clusterNode": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "macAddress": {
            "type": "string"
          },
          "mntIp": {
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve static route

GET/v11_1/controlPlanes/{bladeUUID}/staticRoutes

Use this API command to retrieve static route of control plane.

Response  200
HideShow
Body
{
  "staticRoutes": [
    {
      "networkAddress": "10.4.0.0",
      "subnetMask": "255.255.0.0",
      "gateway": "10.2.0.1",
      "interfaceMode": "Control",
      "metric": 4
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "staticRoutes": {
      "type": "array",
      "description": "Static route for Control Plane",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "networkAddress": {
            "description": "Network Address",
            "type": "string"
          },
          "subnetMask": {
            "description": "Subnet Mask",
            "type": "string"
          },
          "gateway": {
            "description": "Gateway",
            "type": "string"
          },
          "interfaceMode": {
            "description": "Interface Type or UserDefined Interface Name",
            "type": "string"
          },
          "metric": {
            "description": "Metric",
            "type": "integer",
            "minimum": 0,
            "maximum": 999
          }
        }
      }
    }
  }
}

Retrieve user defined interface

GET/v11_1/controlPlanes/{bladeUUID}/userDefinedInterface

Use this API command to retrieve user defined interface of control plane.

Response  200
HideShow
Body
{
  "userDefinedInterface": [
    {
      "name": "User Defined Interface name",
      "physicalInterface": "Control",
      "service": "NotSpecified",
      "ipAddress": "1.1.1.1",
      "subnetMask": "255.255.255.0",
      "vlan": "5"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "userDefinedInterface": {
      "type": "array",
      "description": "User defined interface for Control Plane",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "description": "Name",
            "type": "string"
          },
          "physicalInterface": {
            "description": "Physical interface",
            "type": "string",
            "enum": [
              "Control",
              "Management",
              "Cluster"
            ]
          },
          "service": {
            "description": "Service",
            "type": "string",
            "enum": [
              "NotSpecified",
              "Hotspot",
              "SecondManagementInterface"
            ]
          },
          "ipAddress": {
            "description": "IP Address",
            "type": "string"
          },
          "subnetMask": {
            "description": "Subnet Mask",
            "type": "string"
          },
          "gateway": {
            "description": "Gateway",
            "type": "string"
          },
          "vlan": {
            "description": "Vlan",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve Control Plane Interface list

GET/v11_1/controlPlanes/interfaces

Use this API command to retrieve Control Plane Interface list.

URI Parameters
HideShow
bladeUUID
string (optional) 
Response  200
HideShow
Body
{
  "controlPlaneInterfaces": [
    {
      "id": "br0",
      "name": "Control"
    },
    {
      "id": "br1",
      "name": "Cluster"
    },
    {
      "id": "br2",
      "name": "Management"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "controlPlaneInterfaces": {
      "type": "array",
      "description": "Interface list",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Interface Id",
            "type": "string"
          },
          "name": {
            "description": "Interface Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Modify

PATCH/v11_1/enterprise/controlPlanes/{bladeUUID}

Use this API command to modify the configuration of control plane.

Request
HideShow
Body
{
  "ipMode": "STATIC",
  "ipAddress": "10.2.3.96",
  "subnetMask": "255.255.0.0",
  "gateway": "10.2.0.1",
  "primaryDNSServer": "172.17.17.16"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "gateway": {
      "type": "string"
    },
    "ipAddress": {
      "type": "string"
    },
    "ipMode": {
      "type": "string",
      "enum": [
        "STATIC",
        "DHCP"
      ]
    },
    "natIp": {
      "type": "string"
    },
    "primaryDNSServer": {
      "type": "string"
    },
    "secondaryDNSServer": {
      "type": "string"
    },
    "subnetMask": {
      "type": "string"
    }
  }
}
Response  204

Modify User Defined Interface

PATCH/v11_1/controlPlanes/{bladeUUID}/userDefinedInterface

Use this API command to modify user defined interface of control plane.

Request
HideShow
Body
[
  {
    "name": "User Defined Interface name",
    "physicalInterface": "Control",
    "service": "NotSpecified",
    "ipAddress": "1.1.1.1",
    "subnetMask": "255.255.255.0",
    "vlan": "5"
  }
]
Schema
{
  "type": "array",
  "description": "User defined interface for Control Plane",
  "items": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "name": {
        "description": "Name",
        "type": "string"
      },
      "physicalInterface": {
        "description": "Physical interface",
        "type": "string",
        "enum": [
          "Control",
          "Management",
          "Cluster"
        ]
      },
      "service": {
        "description": "Service",
        "type": "string",
        "enum": [
          "NotSpecified",
          "Hotspot",
          "SecondManagementInterface"
        ]
      },
      "ipAddress": {
        "description": "IP Address",
        "type": "string"
      },
      "subnetMask": {
        "description": "Subnet Mask",
        "type": "string"
      },
      "gateway": {
        "description": "Gateway",
        "type": "string"
      },
      "vlan": {
        "description": "Vlan",
        "type": "string"
      }
    }
  }
}
Response  204

Modify Static Route

PATCH/v11_1/controlPlanes/{bladeUUID}/staticRoutes

Use this API command to modify the static route of control plane.

Request
HideShow
Body
[
  {
    "networkAddress": "10.4.0.0",
    "subnetMask": "255.255.0.0",
    "gateway": "10.2.0.1",
    "interfaceMode": "Control",
    "metric": 4
  }
]
Schema
{
  "type": "array",
  "description": "Static route for control plane.",
  "items": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "networkAddress": {
        "description": "Network Address",
        "type": "string"
      },
      "subnetMask": {
        "description": "Subnet Mask",
        "type": "string"
      },
      "gateway": {
        "description": "Gateway",
        "type": "string"
      },
      "interfaceMode": {
        "description": "Interface Type or UserDefined Interface Name",
        "type": "string"
      },
      "metric": {
        "description": "Metric",
        "type": "integer",
        "minimum": 0,
        "maximum": 999
      }
    }
  }
}
Response  204

Delete Static Route

DELETE/v11_1/controlPlanes/{bladeUUID}/staticRoutes

Use this API command to delete the static route of control plane.

Response  204

Delete User Defined Interface

DELETE/v11_1/controlPlanes/{bladeUUID}/userDefinedInterface

Use this API command to delete the user defined interface of control plane.

Response  204

ZDImport

Get Migrate Status

GET/v11_1/zdImport/status

Get Migrate Status.

URI Parameters
HideShow
details
string (optional) 
Response  200
HideShow
Body
{
  "message": "migarating",
  "details": "details",
  "state": "migarating",
  "progress": 50
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "message": {
      "type": "string"
    },
    "details": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "progress": {
      "type": "integer"
    }
  }
}

Get ZD AP

GET/v11_1/zdImport/getZDAPs

Get ZD AP.

URI Parameters
HideShow
ip
string (required) 
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "mac": "E0:11:12:23:F2:22",
      "connected": "false"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "mac": {
            "type": "string"
          },
          "connected": {
            "type": "string"
          }
        }
      }
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    }
  }
}

ZD Migrate

POST/v11_1/zdImport/migrate

Migrate ZD to SCG.

Request
HideShow
Body
{
  "user": "admin",
  "password": "admin!234",
  "ip": "172.17.60.24",
  "apMacList": [
    "E0:11:12:23:F2:22"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "user": {
      "type": "string"
    },
    "password": {
      "type": "string"
    },
    "ip": {
      "type": "string"
    },
    "apMacList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  201

Connect to ZD

POST/v11_1/zdImport/connectZD

Connect to ZD.

Request
HideShow
Body
{
  "user": "admin",
  "password": "admin!234",
  "ip": "172.17.60.24"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "user": {
      "type": "string"
    },
    "password": {
      "type": "string"
    },
    "ip": {
      "type": "string"
    }
  }
}
Response  201

Administration

Get all licenses

GET/v11_1/licenses

Use this API command to get all licenses currently assign in SCG.

Response  200
HideShow
Body
{
  "totalCount": 4,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "description": "Default AP Capacity License for SZ300",
      "name": "CAPACITY-AP-DEFAULT",
      "count": 10000,
      "createTime": "2017/08/16",
      "expireDate": "2017/11/13"
    },
    {
      "description": "Default feature license for URL Filtering",
      "name": "FEATURE-URL-FILTERING-DEFAULT",
      "count": 10000,
      "createTime": "2017/08/16",
      "expireDate": "2017/11/13"
    },
    {
      "description": "Default AP Direct Tunnel License for SZ300",
      "name": "CAPACITY-RXGW-DEFAULT",
      "count": 10000,
      "createTime": "2017/08/16",
      "expireDate": "2017/11/13"
    },
    {
      "description": "Default SZ 300 Support License",
      "name": "SUP-SZ300-EU-DEFAULT",
      "count": 1,
      "createTime": "2017/08/16",
      "expireDate": "2017/11/13"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "description": {
            "description": "license description",
            "type": "string"
          },
          "name": {
            "description": "license name",
            "type": "string"
          },
          "count": {
            "description": "number of licenses",
            "type": "integer",
            "format": "int64"
          },
          "createTime": {
            "description": "license effective date",
            "type": "string"
          },
          "expireDate": {
            "description": "license expiry date",
            "type": "string"
          }
        }
      }
    }
  }
}

Get licenses summary information

GET/v11_1/licensesSummary

Use this API command to get licenses summary information.

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "licenseTypeDescription": "AP Capacity License",
      "capacityControlLicenseCount": {
        "totalCount": 1000,
        "usedCount": 0
      }
    },
    {
      "licenseTypeDescription": "AP Direct Tunnel License",
      "capacityControlLicenseCount": {
        "totalCount": 1000,
        "usedCount": 0
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "licenseTypeDescription": {
            "description": "license type description",
            "type": "string"
          },
          "capacityControlLicenseCount": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "totalCount": {
                "description": "total count of licenses",
                "type": "integer"
              },
              "usedCount": {
                "description": "consumed count of licenses",
                "type": "integer"
              }
            }
          }
        }
      }
    }
  }
}

Get licenses synchronize logs

GET/v11_1/licensesSyncLogs

Use this API command to get licenses synchronize logs.

Response  200
HideShow
Body
{
  "totalCount": 4,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "syncResult": "SUCCESS",
      "createDateTime": "2017/08/25 02:33:10"
    },
    {
      "syncResult": "SUCCESS",
      "createDateTime": "2017/08/25 02:32:23"
    },
    {
      "syncResult": "SUCCESS",
      "createDateTime": "2017/08/25 00:43:40"
    },
    {
      "syncResult": "SUCCESS",
      "createDateTime": "2017/08/24 05:44:27"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "syncResult": {
            "description": "sync license result",
            "type": "string",
            "enum": [
              "SUCCESS",
              "FAILURE"
            ]
          },
          "createDateTime": {
            "description": "license sync log's create time",
            "type": "string"
          }
        }
      }
    }
  }
}

Get license server

GET/v11_1/licenseServer

Use this API command to get license server configuration.

Response  200
HideShow
Body
{
  "useCloud": false,
  "ipAddress": "192.168.0.1",
  "port": 3223
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "useCloud": {
      "description": "use cloud license server",
      "type": "boolean"
    },
    "ipAddress": {
      "description": "local license server IP address",
      "type": "string"
    },
    "port": {
      "description": "local license server port",
      "type": "integer",
      "minimum": 0,
      "maximum": 65535
    }
  }
}

Retrieve - Admin AAA Server

GET/v11_1/adminaaa/{id}

Use this API command to retrieve an existing Admin AAA server

Response  200
HideShow
Body
{
  "id": "xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "name": "RADIUS0001",
  "type": "RADIUS",
  "defaultRoleMapping": {
    "defaultAdmin": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
    "defaultUserGroup": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
  },
  "radiusServer": {
    "realm": "RADIUS.EXAMPLE.COM",
    "ip": "192.168.2.5",
    "port": 1812,
    "protocol": "PAP",
    "sharedSecret": "XXXXXXXXXXXXXXX",
    "secondaryRadiusServer": null
  },
  "tacacsServer": null,
  "activeDirectoryServer": null,
  "ldapServer": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "type": "string"
    },
    "id": {
      "description": "ID of this Admin AAA Server",
      "type": "string"
    },
    "name": {
      "description": "Name of this Admin AAA Server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "type": {
      "description": "Type(RADIUS/TACACS/AD/LDAP) of this Admin AAA Server, please be infomed that the type name [TACACS] is for TACACS+ (Terminal Access Controller Access-Control System Plus)",
      "type": "string",
      "enum": [
        "RADIUS",
        "TACACS",
        "AD",
        "LDAP"
      ]
    },
    "defaultRoleMapping": {
      "description": "Specification of DefaultRoleMapping object regarding this Admin AAA Server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "defaultAdmin": {
          "description": "DefaultAdmin of DefaultRoleMapping object",
          "type": "string"
        },
        "defaultUserGroup": {
          "description": "DefaultUserGroup of DefaultRoleMapping object",
          "type": "string"
        }
      },
      "required": [
        "defaultUserGroup"
      ]
    },
    "radiusServer": {
      "description": "Specification of RadiusServer object regarding this Admin AAA Server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "realm": {
          "description": "Realm of RADIUS Server object",
          "type": "string",
          "maxLength": 255,
          "pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "ip": {
          "description": "IP address of RADIUS Server object",
          "type": "string"
        },
        "port": {
          "description": "Port number of RADIUS Server object",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "protocol": {
          "type": "string",
          "enum": [
            "PAP",
            "CHAP",
            "PEAP"
          ],
          "default": "PAP"
        },
        "sharedSecret": {
          "description": "Shared secret of RADIUS Server object",
          "type": "string"
        },
        "ipFqdn": {
          "description": "IP address or FQDN of RADIUS Server object",
          "type": "string"
        },
        "secondaryRadiusServer": {
          "description": "Secondary RADIUS Server object of RADIUS Server object",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "ip": {
              "description": "IP address of Secondary RADIUS Server object",
              "type": "string"
            },
            "port": {
              "description": "Port number of Secondary RADIUS Server object",
              "type": "integer",
              "minimum": 1,
              "maximum": 65535
            },
            "protocol": {
              "type": "string",
              "enum": [
                "PAP",
                "CHAP",
                "PEAP"
              ],
              "default": "PAP"
            },
            "sharedSecret": {
              "description": "Shared secret of Secondary RADIUS Server object",
              "type": "string"
            },
            "ipFqdn": {
              "description": "IP address or FQDN of Secondary RADIUS Server object",
              "type": "string"
            },
            "requestTimeOut": {
              "description": "Request timeout(seconds) value of re-connection to primary",
              "type": "integer",
              "minimum": 2,
              "maximum": 20,
              "default": 3
            },
            "maxRetries": {
              "description": "Max number(how many times) of retries for re-connection to primary",
              "type": "integer",
              "minimum": 2,
              "maximum": 10,
              "default": 2
            },
            "retryPriInvl": {
              "description": "Interval of re-connection to primary(1-60 minute)",
              "type": "integer",
              "minimum": 1,
              "maximum": 60,
              "default": 5
            }
          },
          "required": [
            "port",
            "sharedSecret",
            "ipFqdn",
            "requestTimeOut",
            "maxRetries",
            "retryPriInvl"
          ]
        },
        "tlsEnabled": {
          "description": "TLS Enabled",
          "type": "boolean",
          "default": false
        },
        "clientCertId": {
          "description": "Client Certificate Id",
          "type": "string"
        },
        "cnSanIdentity": {
          "maxLength": 1023,
          "type": "string"
        },
        "ocspUrl": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "realm",
        "port",
        "ipFqdn"
      ]
    },
    "tacacsServer": {
      "description": "Specification of TacacsServer object regarding this Admin AAA Server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "service": {
          "description": "Service of TACACS+ Server object",
          "type": "string",
          "maxLength": 255,
          "pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "ip": {
          "description": "IP address of TACACS+ Server object",
          "type": "string"
        },
        "port": {
          "description": "Port number of TACACS+ Server object",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Shared secret of TACACS+ Server object",
          "type": "string"
        }
      },
      "required": [
        "service",
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "activeDirectoryServer": {
      "description": "Specification of ActiveDirectoryServer object regarding this Admin AAA Server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "realm": {
          "description": "Realm of Active Directory Server object",
          "type": "string",
          "maxLength": 255,
          "pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "tlsEnabled": {
          "description": "TLS Enabled",
          "type": "boolean",
          "default": false
        },
        "cnIdentity": {
          "maxLength": 64,
          "type": "string"
        },
        "ip": {
          "description": "IP address of Active Directory Server object",
          "type": "string"
        },
        "port": {
          "description": "Port number of Active Directory Server object",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "windowsDomainName": {
          "description": "Windows Domain Name of Active Directory Server object",
          "type": "string"
        },
        "proxyUserPrincipalName": {
          "description": "The Active Directory proxy account that have permission to perform query operations.",
          "type": "string"
        },
        "proxyUserPassword": {
          "description": "The Active Directory proxy password that have permission to perform query operations.",
          "type": "string"
        }
      },
      "required": [
        "realm",
        "ip",
        "port",
        "windowsDomainName"
      ]
    },
    "ldapServer": {
      "description": "Specification of LdapServer object regarding this Admin AAA Server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "realm": {
          "description": "Realm of LDAP Server object",
          "type": "string",
          "maxLength": 255,
          "pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "tlsEnabled": {
          "description": "TLS Enabled",
          "type": "boolean",
          "default": false
        },
        "cnIdentity": {
          "maxLength": 64,
          "type": "string"
        },
        "ip": {
          "description": "IP address of LDAP Server object",
          "type": "string"
        },
        "port": {
          "description": "Port number of LDAP Server object",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "baseDomainName": {
          "description": "Base Domain Name of LDAP Server object",
          "type": "string"
        },
        "adminDomainName": {
          "description": "Admin Domain Name of LDAP Server object",
          "type": "string"
        },
        "adminPassword": {
          "description": "Admin password of LDAP Server object",
          "type": "string"
        },
        "keyAttribute": {
          "description": "Key attribute of LDAP Server object",
          "type": "string"
        },
        "searchFilter": {
          "description": "Search filter of LDAP Server object",
          "type": "string"
        }
      },
      "required": [
        "realm",
        "ip",
        "port",
        "baseDomainName",
        "adminDomainName",
        "adminPassword",
        "keyAttribute",
        "searchFilter"
      ]
    },
    "creatorUsername": {
      "type": "string"
    },
    "createDateTime": {
      "type": "integer",
      "format": "int64"
    }
  }
}

Retrieve List - Admin AAA Server

GET/v11_1/adminaaa

Use this API command to retrieve the list of Admin AAA server

URI Parameters
HideShow
type
string (required) 

Type of Admin AAA Server (RADIUS/TACACS/AD/LDAP), please be infomed that the type name [TACACS] is for TACACS+ (Terminal Access Controller Access-Control System Plus)

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "RADIUSDS001",
      "type": "RADIUS"
    },
    {
      "id": "xxxxx-xxxx-xxxx-zzzz-xxxxxxxxxxxx",
      "name": "RADIUS002",
      "type": "RADIUS"
    }
  ]
}
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": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "RADIUS",
              "TACACS",
              "AD",
              "LDAP"
            ]
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          }
        }
      }
    }
  }
}

Restart

POST/v11_1/restart

Use this API command to restart the controller.

Response  204

Shutdown

POST/v11_1/shutdown

Use this API command to shut down the controller.

Response  204

Create - Admin AAA Server

POST/v11_1/adminaaa

Use this API command to create a new Admin AAA server

Request
HideShow
Body
{
  "name": "RADIUS001",
  "type": "RADIUS",
  "defaultRoleMapping": {
    "defaultAdmin": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
    "defaultUserGroup": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
  },
  "radiusServer": {
    "realm": "RADIUS.EXAMPLE.COM",
    "ip": "192.168.1.1",
    "port": 1812,
    "sharedSecret": "Secret-Code",
    "secondaryRadiusServer": {
      "ip": "192.168.10.1",
      "port": 1812,
      "sharedSecret": "XXXXXXXXXXXXXXX",
      "requestTimeOut": 4,
      "maxRetries": 6,
      "retryPriInvl": 8
    }
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "type": "string"
    },
    "name": {
      "description": "Specify the name of this Admin AAA Server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "type": {
      "description": "Specify the type(RADIUS/TACACS/AD/LDAP) of this Admin AAA Server, please be infomed that the type name [TACACS] is for TACACS+ (Terminal Access Controller Access-Control System Plus)",
      "type": "string",
      "enum": [
        "RADIUS",
        "TACACS",
        "AD",
        "LDAP"
      ]
    },
    "defaultRoleMapping": {
      "description": "Specify DefaultRoleMapping object of this Admin AAA Server if needed",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "defaultAdmin": {
          "description": "DefaultAdmin of DefaultRoleMapping object",
          "type": "string"
        },
        "defaultUserGroup": {
          "description": "DefaultUserGroup of DefaultRoleMapping object",
          "type": "string"
        }
      },
      "required": [
        "defaultUserGroup"
      ]
    },
    "radiusServer": {
      "description": "This object is for RADIUS server description, please specify it if the type of this Admin AAA Server is [RADIUS]",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "realm": {
          "description": "Realm of RADIUS Server object",
          "type": "string",
          "maxLength": 255,
          "pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "ip": {
          "description": "IP address of RADIUS Server object",
          "type": "string"
        },
        "port": {
          "description": "Port number of RADIUS Server object",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "protocol": {
          "type": "string",
          "enum": [
            "PAP",
            "CHAP",
            "PEAP"
          ],
          "default": "PAP"
        },
        "sharedSecret": {
          "description": "Shared secret of RADIUS Server object",
          "type": "string"
        },
        "ipFqdn": {
          "description": "IP address or FQDN of RADIUS Server object",
          "type": "string"
        },
        "secondaryRadiusServer": {
          "description": "Secondary RADIUS Server object of RADIUS Server object",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "ip": {
              "description": "IP address of Secondary RADIUS Server object",
              "type": "string"
            },
            "port": {
              "description": "Port number of Secondary RADIUS Server object",
              "type": "integer",
              "minimum": 1,
              "maximum": 65535
            },
            "protocol": {
              "type": "string",
              "enum": [
                "PAP",
                "CHAP",
                "PEAP"
              ],
              "default": "PAP"
            },
            "sharedSecret": {
              "description": "Shared secret of Secondary RADIUS Server object",
              "type": "string"
            },
            "ipFqdn": {
              "description": "IP address or FQDN of Secondary RADIUS Server object",
              "type": "string"
            },
            "requestTimeOut": {
              "description": "Request timeout(seconds) value of re-connection to primary",
              "type": "integer",
              "minimum": 2,
              "maximum": 20,
              "default": 3
            },
            "maxRetries": {
              "description": "Max number(how many times) of retries for re-connection to primary",
              "type": "integer",
              "minimum": 2,
              "maximum": 10,
              "default": 2
            },
            "retryPriInvl": {
              "description": "Interval of re-connection to primary(1-60 minute)",
              "type": "integer",
              "minimum": 1,
              "maximum": 60,
              "default": 5
            }
          },
          "required": [
            "port",
            "sharedSecret",
            "ipFqdn",
            "requestTimeOut",
            "maxRetries",
            "retryPriInvl"
          ]
        },
        "tlsEnabled": {
          "description": "TLS Enabled",
          "type": "boolean",
          "default": false
        },
        "clientCertId": {
          "description": "Client Certificate Id",
          "type": "string"
        },
        "cnSanIdentity": {
          "maxLength": 1023,
          "type": "string"
        },
        "ocspUrl": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "realm",
        "port",
        "ipFqdn"
      ]
    },
    "tacacsServer": {
      "description": "This object is for TACACS+ server description, please specify it if the type of this Admin AAA Server is [TACACS], please be infomed that the type name [TACACS] is for TACACS+ (Terminal Access Controller Access-Control System Plus)",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "service": {
          "description": "Service of TACACS+ Server object",
          "type": "string",
          "maxLength": 255,
          "pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "ip": {
          "description": "IP address of TACACS+ Server object",
          "type": "string"
        },
        "port": {
          "description": "Port number of TACACS+ Server object",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Shared secret of TACACS+ Server object",
          "type": "string"
        }
      },
      "required": [
        "service",
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "activeDirectoryServer": {
      "description": "This object is for Active Directory server description, please specify it if the type of this Admin AAA Server is [AD]",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "realm": {
          "description": "Realm of Active Directory Server object",
          "type": "string",
          "maxLength": 255,
          "pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "tlsEnabled": {
          "description": "TLS Enabled",
          "type": "boolean",
          "default": false
        },
        "cnIdentity": {
          "maxLength": 64,
          "type": "string"
        },
        "ip": {
          "description": "IP address of Active Directory Server object",
          "type": "string"
        },
        "port": {
          "description": "Port number of Active Directory Server object",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "windowsDomainName": {
          "description": "Windows Domain Name of Active Directory Server object",
          "type": "string"
        },
        "proxyUserPrincipalName": {
          "description": "The Active Directory proxy account that have permission to perform query operations.",
          "type": "string"
        },
        "proxyUserPassword": {
          "description": "The Active Directory proxy password that have permission to perform query operations.",
          "type": "string"
        }
      },
      "required": [
        "realm",
        "ip",
        "port",
        "windowsDomainName"
      ]
    },
    "ldapServer": {
      "description": "This object is for LDAP server description, please specify it if the type of this Admin AAA Server is [LDAP]",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "realm": {
          "description": "Realm of LDAP Server object",
          "type": "string",
          "maxLength": 255,
          "pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "tlsEnabled": {
          "description": "TLS Enabled",
          "type": "boolean",
          "default": false
        },
        "cnIdentity": {
          "maxLength": 64,
          "type": "string"
        },
        "ip": {
          "description": "IP address of LDAP Server object",
          "type": "string"
        },
        "port": {
          "description": "Port number of LDAP Server object",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "baseDomainName": {
          "description": "Base Domain Name of LDAP Server object",
          "type": "string"
        },
        "adminDomainName": {
          "description": "Admin Domain Name of LDAP Server object",
          "type": "string"
        },
        "adminPassword": {
          "description": "Admin password of LDAP Server object",
          "type": "string"
        },
        "keyAttribute": {
          "description": "Key attribute of LDAP Server object",
          "type": "string"
        },
        "searchFilter": {
          "description": "Search filter of LDAP Server object",
          "type": "string"
        }
      },
      "required": [
        "realm",
        "ip",
        "port",
        "baseDomainName",
        "adminDomainName",
        "adminPassword",
        "keyAttribute",
        "searchFilter"
      ]
    }
  },
  "required": [
    "name",
    "type"
  ]
}
Response  201
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Update license server

PUT/v11_1/licenseServer

Use this API command to update license server configuration.

Request
HideShow
Body
{
  "useCloud": false,
  "ipAddress": "192.168.0.1",
  "port": 3223
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "useCloud": {
      "type": "boolean"
    },
    "ipAddress": {
      "type": "string"
    },
    "port": {
      "type": "integer",
      "minimum": 0,
      "maximum": 65535
    }
  },
  "required": [
    "useCloud"
  ]
}
Response  204

Sync licenses

PUT/v11_1/licenses/sync

Use this API command to ask all SCG in cluster to sync licenses from license server.

Response  204

Modify - Admin AAA Server

PUT/v11_1/adminaaa/{id}

Use this API command to modify an existing Admin AAA server

Request
HideShow
Body
{
  "name": "RADIUS0001",
  "type": "RADIUS",
  "radiusServer": {
    "realm": "RADIUS.EXAMPLE.COM",
    "ip": "192.168.1.5",
    "port": 1812,
    "protocol": "CHAP",
    "sharedSecret": "XXXXXXXXXXXXXXX"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Specify the name of this Admin AAA Server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "type": {
      "description": "Specify the type(RADIUS/TACACS/AD/LDAP) of this Admin AAA Server, please be infomed that the type name [TACACS] is for TACACS+ (Terminal Access Controller Access-Control System Plus)",
      "type": "string",
      "enum": [
        "RADIUS",
        "TACACS",
        "AD",
        "LDAP"
      ]
    },
    "defaultRoleMapping": {
      "description": "Specify DefaultRoleMapping object of this Admin AAA Server if needed",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "defaultAdmin": {
          "description": "DefaultAdmin of DefaultRoleMapping object",
          "type": "string"
        },
        "defaultUserGroup": {
          "description": "DefaultUserGroup of DefaultRoleMapping object",
          "type": "string"
        }
      },
      "required": [
        "defaultUserGroup"
      ]
    },
    "radiusServer": {
      "description": "Specification of RADIUS Server object regarding this Admin AAA Server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "realm": {
          "description": "Realm of RADIUS Server object",
          "type": "string",
          "maxLength": 255,
          "pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "ip": {
          "description": "IP address of RADIUS Server object",
          "type": "string"
        },
        "port": {
          "description": "Port number of RADIUS Server object",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "protocol": {
          "type": "string",
          "enum": [
            "PAP",
            "CHAP",
            "PEAP"
          ]
        },
        "sharedSecret": {
          "description": "Shared secret of RADIUS Server object",
          "type": "string"
        },
        "ipFqdn": {
          "description": "IP address or FQDN of RADIUS Server object",
          "type": "string"
        },
        "secondaryRadiusServer": {
          "description": "Secondary RADIUS Server object of RADIUS Server object",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "ip": {
              "description": "IP address of Secondary RADIUS Server object",
              "type": "string"
            },
            "port": {
              "description": "Port number of Secondary RADIUS Server object",
              "type": "integer",
              "minimum": 1,
              "maximum": 65535
            },
            "protocol": {
              "type": "string",
              "enum": [
                "PAP",
                "CHAP",
                "PEAP"
              ]
            },
            "sharedSecret": {
              "description": "Shared secret of Secondary RADIUS Server object",
              "type": "string"
            },
            "ipFqdn": {
              "description": "IP address or FQDN of Secondary RADIUS Server object",
              "type": "string"
            },
            "requestTimeOut": {
              "description": "Request timeout(seconds) value of re-connection to primary",
              "type": "integer",
              "minimum": 2,
              "maximum": 20
            },
            "maxRetries": {
              "description": "Max number(how many times) of retries for re-connection to primary",
              "type": "integer",
              "minimum": 2,
              "maximum": 10
            },
            "retryPriInvl": {
              "description": "Interval of re-connection to primary(1-60 minute)",
              "type": "integer",
              "minimum": 1,
              "maximum": 60
            }
          },
          "required": [
            "port",
            "sharedSecret",
            "ipFqdn",
            "requestTimeOut",
            "maxRetries",
            "retryPriInvl"
          ]
        },
        "tlsEnabled": {
          "description": "TLS Enabled",
          "type": "boolean"
        },
        "clientCertId": {
          "description": "Client Certificate Id",
          "type": "string"
        },
        "cnSanIdentity": {
          "maxLength": 1023,
          "type": "string"
        },
        "ocspUrl": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "realm",
        "port",
        "ipFqdn"
      ]
    },
    "tacacsServer": {
      "description": "Specification of TACACS+ Server object regarding this Admin AAA Server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "service": {
          "description": "Service of TACACS+ Server object",
          "type": "string",
          "maxLength": 255,
          "pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "ip": {
          "description": "IP address of TACACS+ Server object",
          "type": "string"
        },
        "port": {
          "description": "Port number of TACACS+ Server object",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Shared secret of TACACS+ Server object",
          "type": "string"
        }
      },
      "required": [
        "service",
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "activeDirectoryServer": {
      "description": "Specification of Active Directory Server object regarding this Admin AAA Server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "realm": {
          "description": "Realm of Active Directory Server object",
          "type": "string",
          "maxLength": 255,
          "pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "tlsEnabled": {
          "description": "TLS Enabled",
          "type": "boolean"
        },
        "cnIdentity": {
          "maxLength": 64,
          "type": "string"
        },
        "ip": {
          "description": "IP address of Active Directory Server object",
          "type": "string"
        },
        "port": {
          "description": "Port number of Active Directory Server object",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "windowsDomainName": {
          "description": "Windows Domain Name of Active Directory Server object",
          "type": "string"
        },
        "proxyUserPrincipalName": {
          "description": "The Active Directory proxy account that have permission to perform query operations.",
          "type": "string"
        },
        "proxyUserPassword": {
          "description": "The Active Directory proxy password that have permission to perform query operations.",
          "type": "string"
        }
      },
      "required": [
        "realm",
        "ip",
        "port",
        "windowsDomainName"
      ]
    },
    "ldapServer": {
      "description": "Specification of LDAP Server object regarding this Admin AAA Server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "realm": {
          "description": "Realm of LDAP Server object",
          "type": "string",
          "maxLength": 255,
          "pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "tlsEnabled": {
          "description": "TLS Enabled",
          "type": "boolean"
        },
        "cnIdentity": {
          "maxLength": 64,
          "type": "string"
        },
        "ip": {
          "description": "IP address of LDAP Server object",
          "type": "string"
        },
        "port": {
          "description": "Port number of LDAP Server object",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "baseDomainName": {
          "description": "Base Domain Name of LDAP Server object",
          "type": "string"
        },
        "adminDomainName": {
          "description": "Admin Domain Name of LDAP Server object",
          "type": "string"
        },
        "adminPassword": {
          "description": "Admin password of LDAP Server object",
          "type": "string"
        },
        "keyAttribute": {
          "description": "Key attribute of LDAP Server object",
          "type": "string"
        },
        "searchFilter": {
          "description": "Search filter of LDAP Server object",
          "type": "string"
        }
      },
      "required": [
        "realm",
        "ip",
        "port",
        "baseDomainName",
        "adminDomainName",
        "adminPassword",
        "keyAttribute",
        "searchFilter"
      ]
    }
  },
  "required": [
    "name",
    "type"
  ]
}
Response  200

Delete - Admin AAA Server

DELETE/v11_1/adminaaa/{id}

Use this API command to delete an existing Admin AAA server

Response  204

Global reference

Get friendly name of usable language

GET/v11_1/globalSettings/friendlyNameLang

Use this API command to get friendly name of usable language for profile: Hotspot2.0 Identity Provider.

Response  200
HideShow
Body
{
  "rawDataTotalCount": 0,
  "totalCount": 12,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "display": "French",
      "value": "fre"
    },
    {
      "display": "Swedish",
      "value": "swe"
    },
    {
      "display": "English",
      "value": "eng"
    },
    {
      "display": "Danish",
      "value": "dan"
    },
    {
      "display": "Japanese",
      "value": "jpn"
    },
    {
      "display": "German",
      "value": "ger"
    },
    {
      "display": "Turkish",
      "value": "tur"
    },
    {
      "display": "Korean",
      "value": "kor"
    },
    {
      "display": "Czech",
      "value": "cze"
    },
    {
      "display": "Chinese",
      "value": "chi"
    },
    {
      "display": "Spanish",
      "value": "spa"
    },
    {
      "display": "Dutch",
      "value": "dut"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total count of FriendlyName of language",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more FriendlyName of language after the list that is currently displayed",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first FriendlyName of language returned out of the complete FTP list",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "display": {
            "description": "Display name",
            "type": "string"
          },
          "value": {
            "description": "value of language used on create Hotspot 2.0 Identity provider (Language in OSU Service Description) profile",
            "type": "string"
          }
        }
      }
    }
  }
}

Get friendly name of usable language

GET/v11_1/globalSettings/portalLang

Use this API command to get friendly name of usable language for profile: Guest Access (Language in General Options), Web Auth (Language in General Options).

Response  200
HideShow
Body
{
  "rawDataTotalCount": 0,
  "totalCount": 14,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "display": "Turkish",
      "value": "tr_TR"
    },
    {
      "display": "Brazilian Portuguese",
      "value": "pt_BR"
    },
    {
      "display": "French",
      "value": "fr_FR"
    },
    {
      "display": "Chinese Simplified",
      "value": "zh_CN"
    },
    {
      "display": "Spanish",
      "value": "es_ES"
    },
    {
      "display": "Swedish",
      "value": "se_SE"
    },
    {
      "display": "Dutch",
      "value": "nl_NL"
    },
    {
      "display": "Danish",
      "value": "da_DK"
    },
    {
      "display": "Arabic",
      "value": "ar_SA"
    },
    {
      "display": "Chinese Traditional",
      "value": "zh_TW"
    },
    {
      "display": "Japanese",
      "value": "ja_JP"
    },
    {
      "display": "German",
      "value": "de_DE"
    },
    {
      "display": "Czech",
      "value": "cz_CZ"
    },
    {
      "display": "English",
      "value": "en_US"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total portal name count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more portal names after the list that is currently displayed",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first portal names returned out of the complete portal names list",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "display": {
            "description": "Display name",
            "type": "string"
          },
          "value": {
            "description": "value of language used on create Hotspot 2.0 Identity provider (Language in OSU Service Description) profile",
            "type": "string"
          }
        }
      }
    }
  }
}

GDPR

Execute a GDPR report action

POST/v11_1/gdpr/report

Use this API command to execute a client-related data search or delete task and upload a report to FTP. Also use this API to check task progress or to interrupt it.

Request
HideShow
Body
{
  "clientMac": "AA:BB:CC:DD:EE:FF",
  "action": "SEARCH",
  "ftp": {
    "ftpHost": "172.30.1.1",
    "ftpPort": 21,
    "ftpRemoteDirectory": "/home/user",
    "ftpUserName": "user",
    "ftpPassword": "passowrd",
    "ftpProtocol": "FTP"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "clientMac": {
      "description": "Client mac",
      "type": "string"
    },
    "action": {
      "description": "Request action",
      "type": "string",
      "enum": [
        "SEARCH",
        "DELETE",
        "INTERRUPT",
        "PROGRESS"
      ]
    },
    "ftp": {
      "description": "FTP information for search/delete report upload",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ftpHost": {
          "description": "IP/DN of FTP",
          "type": "string"
        },
        "ftpPort": {
          "description": "Port used by FTP",
          "type": "integer",
          "minimum": 21,
          "maximum": 65535
        },
        "ftpRemoteDirectory": {
          "description": "Destination directory used for file upload",
          "type": "string"
        },
        "ftpUserName": {
          "description": "Username for FTP login",
          "type": "string"
        },
        "ftpPassword": {
          "description": "Password for FTP login",
          "type": "string"
        },
        "ftpProtocol": {
          "description": "Protocol used",
          "type": "string",
          "enum": [
            "FTP",
            "SFTP"
          ]
        }
      },
      "required": [
        "ftpHost",
        "ftpPort"
      ]
    }
  },
  "required": [
    "clientMac",
    "action"
  ]
}
Response  200

FtpServerSettings

Retrieve FTP server information

GET/v11_1/ftps/{ftpId}

Retrieve information of specific FTP server.

Response  200
HideShow
Body
{
  "id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "tenantId": "abty8777-c3cd-4f26-8c9b-3e7b055c4f26",
  "domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
  "ftpHost": "172.30.1.1",
  "ftpPort": 22,
  "ftpRemoteDirectory": "/home/user",
  "ftpUserName": "user",
  "ftpPassword": "passowrd",
  "creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "createDatetime": 1452527522341,
  "lastModifiedBy": "admin",
  "lastModifiedOn": 1462527522341,
  "ftpName": "Ftp Server",
  "ftpProtocol": "FTP"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "FTP Id"
    },
    "tenantId": {
      "type": "string",
      "description": "Tenant Id"
    },
    "domainId": {
      "type": "string",
      "description": "Domain Id"
    },
    "ftpHost": {
      "type": "string",
      "minLength": 2,
      "maxLength": 256,
      "description": "IP/DN of FTP"
    },
    "ftpPort": {
      "type": "integer",
      "minimum": 20,
      "maximum": 65535,
      "description": "Port used by FTP"
    },
    "ftpRemoteDirectory": {
      "type": "string",
      "maxLength": 512,
      "description": "Destination directory used for file upload"
    },
    "ftpUserName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Username for login"
    },
    "ftpPassword": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Password for login"
    },
    "creatorUUID": {
      "type": "string",
      "description": "creator id"
    },
    "createDatetime": {
      "type": "integer",
      "format": "int64",
      "description": "entry create time"
    },
    "lastModifiedBy": {
      "type": "string",
      "description": "last modified user"
    },
    "lastModifiedOn": {
      "type": "integer",
      "format": "int64",
      "description": "last modified time"
    },
    "ftpName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "description": "FTP name"
    },
    "ftpProtocol": {
      "type": "string",
      "enum": [
        "FTP",
        "SFTP"
      ],
      "description": "Protocol used"
    }
  }
}

Test FTP server

GET/v11_1/ftps/test

Test ftp server of specific FTP server settings.

Request
HideShow
Body
{
  "id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "tenantId": "abty8777-c3cd-4f26-8c9b-3e7b055c4f26",
  "domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
  "ftpHost": "172.30.1.1",
  "ftpPort": 22,
  "ftpRemoteDirectory": "/home/user",
  "ftpUserName": "user",
  "ftpPassword": "passowrd",
  "creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "createDatetime": 1452527522341,
  "lastModifiedBy": "admin",
  "lastModifiedOn": 1462527522341,
  "ftpName": "Ftp Server",
  "ftpProtocol": "FTP"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "FTP Id"
    },
    "tenantId": {
      "type": "string",
      "description": "Tenant Id"
    },
    "domainId": {
      "type": "string",
      "description": "Domain Id"
    },
    "ftpHost": {
      "type": "string",
      "minLength": 2,
      "maxLength": 256,
      "description": "IP/DN of FTP"
    },
    "ftpPort": {
      "type": "integer",
      "minimum": 20,
      "maximum": 65535,
      "description": "Port used by FTP"
    },
    "ftpRemoteDirectory": {
      "type": "string",
      "maxLength": 512,
      "description": "Destination directory used for file upload"
    },
    "ftpUserName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Username for login"
    },
    "ftpPassword": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Password for login"
    },
    "creatorUUID": {
      "type": "string",
      "description": "creator id"
    },
    "createDatetime": {
      "type": "integer",
      "format": "int64",
      "description": "entry create time"
    },
    "lastModifiedBy": {
      "type": "string",
      "description": "last modified user"
    },
    "lastModifiedOn": {
      "type": "integer",
      "format": "int64",
      "description": "last modified time"
    },
    "ftpName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "description": "FTP name"
    },
    "ftpProtocol": {
      "type": "string",
      "enum": [
        "FTP",
        "SFTP"
      ],
      "description": "Protocol used"
    }
  }
}
Response  200
HideShow
Body
{
  "success": "true",
  "error": "",
  "data": "true",
  "extra": ""
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "success": {
      "description": "The status of http request",
      "type": "boolean"
    },
    "error": {
      "description": "The error message of http request",
      "type": "string"
    },
    "data": {
      "description": "The testing result",
      "type": "boolean"
    },
    "extra": {
      "description": "The extra info",
      "type": "string"
    }
  }
}

Test FTP server

GET/v11_1/ftps/test/{ftpId}

Test ftp server of specific FTP server id.

Response  200
HideShow
Body
{
  "success": "true",
  "error": "",
  "data": "true",
  "extra": ""
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "success": {
      "description": "The status of http request",
      "type": "boolean"
    },
    "error": {
      "description": "The error message of http request",
      "type": "string"
    },
    "data": {
      "description": "The testing result",
      "type": "boolean"
    },
    "extra": {
      "description": "The extra info",
      "type": "string"
    }
  }
}

Retrieve FTP server list

POST/v11_1/ftps/query

Retrieve information of all FTP server. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 20,
  "hasMore": true,
  "firstIndex": 0,
  "extra": "",
  "list": [
    {
      "id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "tenantId": "abty8777-c3cd-4f26-8c9b-3e7b055c4f26",
      "domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
      "ftpHost": "172.30.1.1",
      "ftpPort": 22,
      "ftpRemoteDirectory": "/home/user",
      "ftpUserName": "user",
      "ftpPassword": "passowrd",
      "creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "createDatetime": 1452527522341,
      "lastModifiedBy": "admin",
      "lastModifiedOn": 1462527522341,
      "ftpName": "Ftp Server",
      "ftpProtocol": "FTP"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total FTP count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more FTPs after the list that is currently displayed",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first FTP returned out of the complete FTP list",
      "type": "integer"
    },
    "extra": {
      "description": "extra information for ftp",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "description": "FTP Id"
          },
          "tenantId": {
            "type": "string",
            "description": "Tenant Id"
          },
          "domainId": {
            "type": "string",
            "description": "Domain Id"
          },
          "ftpHost": {
            "type": "string",
            "minLength": 2,
            "maxLength": 256,
            "description": "IP/DN of FTP"
          },
          "ftpPort": {
            "type": "integer",
            "minimum": 20,
            "maximum": 65535,
            "description": "Port used by FTP"
          },
          "ftpRemoteDirectory": {
            "type": "string",
            "maxLength": 512,
            "description": "Destination directory used for file upload"
          },
          "ftpUserName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "description": "Username for login"
          },
          "ftpPassword": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "description": "Password for login"
          },
          "creatorUUID": {
            "type": "string",
            "description": "creator id"
          },
          "createDatetime": {
            "type": "integer",
            "format": "int64",
            "description": "entry create time"
          },
          "lastModifiedBy": {
            "type": "string",
            "description": "last modified user"
          },
          "lastModifiedOn": {
            "type": "integer",
            "format": "int64",
            "description": "last modified time"
          },
          "ftpName": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "description": "FTP name"
          },
          "ftpProtocol": {
            "type": "string",
            "enum": [
              "FTP",
              "SFTP"
            ],
            "description": "Protocol used"
          }
        }
      }
    }
  }
}

Add FTP server

POST/v11_1/ftps

Add FTP server.

Request
HideShow
Body
{
  "id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "tenantId": "abty8777-c3cd-4f26-8c9b-3e7b055c4f26",
  "domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
  "ftpHost": "172.30.1.1",
  "ftpPort": 22,
  "ftpRemoteDirectory": "/home/user",
  "ftpUserName": "user",
  "ftpPassword": "passowrd",
  "creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "createDatetime": 1452527522341,
  "lastModifiedBy": "admin",
  "lastModifiedOn": 1462527522341,
  "ftpName": "Ftp Server",
  "ftpProtocol": "FTP"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "FTP Id"
    },
    "tenantId": {
      "type": "string",
      "description": "Tenant Id"
    },
    "domainId": {
      "type": "string",
      "description": "Domain Id"
    },
    "ftpHost": {
      "type": "string",
      "minLength": 2,
      "maxLength": 256,
      "description": "IP/DN of FTP"
    },
    "ftpPort": {
      "type": "integer",
      "minimum": 20,
      "maximum": 65535,
      "description": "Port used by FTP"
    },
    "ftpRemoteDirectory": {
      "type": "string",
      "maxLength": 512,
      "description": "Destination directory used for file upload"
    },
    "ftpUserName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Username for login"
    },
    "ftpPassword": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Password for login"
    },
    "creatorUUID": {
      "type": "string",
      "description": "creator id"
    },
    "createDatetime": {
      "type": "integer",
      "format": "int64",
      "description": "entry create time"
    },
    "lastModifiedBy": {
      "type": "string",
      "description": "last modified user"
    },
    "lastModifiedOn": {
      "type": "integer",
      "format": "int64",
      "description": "last modified time"
    },
    "ftpName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "description": "FTP name"
    },
    "ftpProtocol": {
      "type": "string",
      "enum": [
        "FTP",
        "SFTP"
      ],
      "description": "Protocol used"
    }
  }
}
Response  201

Update FTP server

PATCH/v11_1/ftps/{ftpId}

Update FTP server settings.

Request
HideShow
Body
{
  "id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "tenantId": "abty8777-c3cd-4f26-8c9b-3e7b055c4f26",
  "domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
  "ftpHost": "172.30.1.1",
  "ftpPort": 22,
  "ftpRemoteDirectory": "/home/user",
  "ftpUserName": "user",
  "ftpPassword": "passowrd",
  "creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "createDatetime": 1452527522341,
  "lastModifiedBy": "admin",
  "lastModifiedOn": 1462527522341,
  "ftpName": "Ftp Server",
  "ftpProtocol": "FTP"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "FTP Id"
    },
    "tenantId": {
      "type": "string",
      "description": "Tenant Id"
    },
    "domainId": {
      "type": "string",
      "description": "Domain Id"
    },
    "ftpHost": {
      "type": "string",
      "minLength": 2,
      "maxLength": 256,
      "description": "IP/DN of FTP"
    },
    "ftpPort": {
      "type": "integer",
      "minimum": 20,
      "maximum": 65535,
      "description": "Port used by FTP"
    },
    "ftpRemoteDirectory": {
      "type": "string",
      "maxLength": 512,
      "description": "Destination directory used for file upload"
    },
    "ftpUserName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Username for login"
    },
    "ftpPassword": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Password for login"
    },
    "creatorUUID": {
      "type": "string",
      "description": "creator id"
    },
    "createDatetime": {
      "type": "integer",
      "format": "int64",
      "description": "entry create time"
    },
    "lastModifiedBy": {
      "type": "string",
      "description": "last modified user"
    },
    "lastModifiedOn": {
      "type": "integer",
      "format": "int64",
      "description": "last modified time"
    },
    "ftpName": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "description": "FTP name"
    },
    "ftpProtocol": {
      "type": "string",
      "enum": [
        "FTP",
        "SFTP"
      ],
      "description": "Protocol used"
    }
  }
}
Response  204

Remove FTP server

DELETE/v11_1/ftps/{ftpId}

Remove FTP server.

Response  204

Remove FTP servers

DELETE/v11_1/ftps

Remove FTP servers.

Request
HideShow
Body
{
  "idList": [
    "71d7b8a9-33ed-45e4-9140-7b2c31e5d6f5",
    "7c450388-8b67-4b01-b926-d71ec48b4d20"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200

DNS Server Management

Retrieve

GET/v11_1/profiles/dnsserver/{id}

Use this API command to retrieve DNS server profile.

Response  200
HideShow
Body
{
  "name": "DNS server name",
  "description": "DNS server description",
  "primaryIp": "172.17.60.61",
  "secondaryIp": "172.17.60.53",
  "tertiaryIp": "172.17.60.50"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the dns server service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the dns server service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "primaryIp": {
      "description": "Primary ip of DNS server service",
      "type": "string"
    },
    "secondaryIp": {
      "description": "Secondary ip of DNS server service",
      "type": "string"
    },
    "tertiaryIp": {
      "description": "Tertiary ip of DNS server service",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "domainId": {
      "description": "Domain UUID",
      "type": "string"
    },
    "id": {
      "description": "Profile Id",
      "type": "string"
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Retrieve list

GET/v11_1/profiles/dnsserver

Use this API command to retrieve a list of DNS server profile.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "id": "a0a77450-e9da-11e6-952e-64006a6a50c6",
      "name": "ruckDNS",
      "description": "",
      "primaryIp": "1.5.2.2",
      "secondaryIp": "",
      "tertiaryIp": null,
      "createDateTime": 1486103588885,
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "admin",
      "modifiedDateTime": 1486103588885,
      "creatorUsername": "admin",
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    }
  ],
  "extra": {
    "rbacMetadata": [
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      }
    ]
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for User Traffic profile",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "description": "Name of the dns server service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the dns server service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "primaryIp": {
            "description": "Primary ip of DNS server service",
            "type": "string"
          },
          "secondaryIp": {
            "description": "Secondary ip of DNS server service",
            "type": "string"
          },
          "tertiaryIp": {
            "description": "Tertiary ip of DNS server service",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "domainId": {
            "description": "Domain UUID",
            "type": "string"
          },
          "id": {
            "description": "Profile Id",
            "type": "string"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve List - DNS server profile by query criteria

POST/v11_1/profiles/dnsserver/query

Use this API command to retrieve a list of DNS server profile by query criteria. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "id": "a0a77450-e9da-11e6-952e-64006a6a50c6",
      "name": "ruckDNS",
      "description": "",
      "primaryIp": "1.5.2.2",
      "secondaryIp": "",
      "tertiaryIp": null,
      "createDateTime": 1486103588885,
      "modifierId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "modifierUsername": "admin",
      "modifiedDateTime": 1486103588885,
      "creatorUsername": "admin",
      "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    }
  ],
  "extra": {
    "rbacMetadata": [
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      }
    ]
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for User Traffic profile",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "description": "Name of the dns server service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the dns server service",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "primaryIp": {
            "description": "Primary ip of DNS server service",
            "type": "string"
          },
          "secondaryIp": {
            "description": "Secondary ip of DNS server service",
            "type": "string"
          },
          "tertiaryIp": {
            "description": "Tertiary ip of DNS server service",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "domainId": {
            "description": "Domain UUID",
            "type": "string"
          },
          "id": {
            "description": "Profile Id",
            "type": "string"
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        }
      }
    }
  }
}

Create

POST/v11_1/profiles/dnsserver

Use this API command to create DNS server profile.

Request
HideShow
Body
{
  "name": "DNS server name",
  "description": "DNS server description",
  "primaryIp": "172.17.60.61",
  "secondaryIp": "172.17.60.53",
  "tertiaryIp": "172.17.60.50"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the dns server service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the dns server service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "primaryIp": {
      "description": "Primary ip of DNS server service",
      "type": "string"
    },
    "secondaryIp": {
      "description": "Secondary ip of DNS server service",
      "type": "string"
    },
    "tertiaryIp": {
      "description": "Tertiary ip of DNS server service",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "domainId": {
      "description": "Domain UUID",
      "type": "string"
    }
  },
  "required": [
    "name",
    "primaryIp"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Clone

POST/v11_1/profiles/dnsserver/clone/{id}

Use this API command to clone an DNS server profile.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "oldName": {
      "description": "original name",
      "type": "string"
    },
    "oldId": {
      "description": "original name",
      "type": "string"
    },
    "newName": {
      "description": "Id for new profile",
      "type": "string"
    },
    "newId": {
      "description": "name for new profile",
      "type": "string"
    }
  }
}
Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "oldName": {
      "description": "original name",
      "type": "string"
    },
    "oldId": {
      "description": "original name",
      "type": "string"
    },
    "newName": {
      "description": "Id for new profile",
      "type": "string"
    },
    "newId": {
      "description": "name for new profile",
      "type": "string"
    }
  }
}

Modify

PATCH/v11_1/profiles/dnsserver/{id}

Use this API command to modify the configuration of DNS server profile.

Request
HideShow
Body
{
  "name": "DNS server name",
  "description": "DNS server description",
  "primaryIp": "172.17.60.61",
  "secondaryIp": "172.17.60.53",
  "tertiaryIp": "172.17.60.50"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the dns server service",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the dns server service",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "primaryIp": {
      "description": "Primary ip of DNS server service",
      "type": "string"
    },
    "secondaryIp": {
      "description": "Secondary ip of DNS server service",
      "type": "string"
    },
    "tertiaryIp": {
      "description": "Tertiary ip of DNS server service",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "domainId": {
      "description": "Domain UUID",
      "type": "string"
    },
    "id": {
      "description": "Profile Id",
      "type": "string"
    }
  }
}
Response  204

Delete

DELETE/v11_1/profiles/dnsserver/{id}

Use this API command to delete DNS server profile.

Response  204

Delete a list of DNS server profile

DELETE/v11_1/profiles/dnsserver

Use this API command to delete a list of DNS server profile.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

SMS Gateway

Get SMS gateway

GET/v11_1/smsGateway

Get SMS gateway.

URI Parameters
HideShow
domainId
string (optional) 

MSP/Partner domain id of the SMS gateway

Response  200
HideShow
Body
{
  "id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
  "serverType": "Twilio",
  "enabled": 1,
  "serverName": "Twilio SMS server",
  "accountSid": "My SID",
  "authToken": "My Token",
  "from": "Ruckus"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "SMS Id",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": [
        "string",
        "null"
      ]
    },
    "serverType": {
      "description": "Server type",
      "type": "string",
      "enum": [
        "Twilio"
      ]
    },
    "enabled": {
      "description": "Enabled SMS server or not",
      "type": "integer",
      "enum": [
        0,
        1
      ]
    },
    "serverName": {
      "description": "Server Name",
      "type": "string"
    },
    "accountSid": {
      "description": "Account SID",
      "type": "string"
    },
    "authToken": {
      "description": "Auth Token",
      "type": "string"
    },
    "from": {
      "description": "From",
      "type": "string"
    }
  }
}

Query SMS gateway

POST/v11_1/smsGateway/query

Query SMS gateway. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": true,
  "firstIndex": 0,
  "list": [
    {
      "id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
      "domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
      "serverType": "Twilio",
      "enabled": 1,
      "serverName": "Twilio SMS server",
      "accountSid": "My SID",
      "authToken": "My Token",
      "from": "Ruckus"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total SMS gateway count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more SMS gateway after the list that is currently displayed",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first SMS gateway returned out of the complete SMS gateway list",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "SMS Id",
            "type": "string"
          },
          "domainId": {
            "description": "Domain Id",
            "type": [
              "string",
              "null"
            ]
          },
          "serverType": {
            "description": "Server type",
            "type": "string",
            "enum": [
              "Twilio"
            ]
          },
          "enabled": {
            "description": "Enabled SMS server or not",
            "type": "integer",
            "enum": [
              0,
              1
            ]
          },
          "serverName": {
            "description": "Server Name",
            "type": "string"
          },
          "accountSid": {
            "description": "Account SID",
            "type": "string"
          },
          "authToken": {
            "description": "Auth Token",
            "type": "string"
          },
          "from": {
            "description": "From",
            "type": "string"
          }
        }
      }
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    }
  }
}

Update SMS gateway

PATCH/v11_1/smsGateway

Update SMS gateway.

Request
HideShow
Body
{
  "id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "domainId": "b055c7c2-c3cd-4f26-8c9b-4f26055c7c25",
  "serverType": "Twilio",
  "enabled": 1,
  "serverName": "Twilio SMS server",
  "accountSid": "My SID",
  "authToken": "My Token",
  "from": "Ruckus"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "SMS Id",
      "type": "string"
    },
    "domainId": {
      "description": "Domain Id",
      "type": [
        "string",
        "null"
      ]
    },
    "serverType": {
      "description": "Server type",
      "type": "string",
      "enum": [
        "Twilio"
      ]
    },
    "enabled": {
      "description": "Enabled SMS server or not",
      "type": "integer",
      "enum": [
        0,
        1
      ]
    },
    "serverName": {
      "description": "Server Name",
      "type": "string"
    },
    "accountSid": {
      "description": "Account SID",
      "type": "string"
    },
    "authToken": {
      "description": "Auth Token",
      "type": "string"
    },
    "from": {
      "description": "From",
      "type": "string"
    }
  }
}
Response  200

Application Log And Status

Retrieve List

GET/v11_1/applications/{bladeUUID}

Use this API command to retrieve a list of application log and status.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "applicationName": "API",
      "healthStatus": "Online",
      "logLevel": "WARN",
      "numOfLogs": 1,
      "logFileNames": [
        "api.log"
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "applicationName": {
            "description": "Application name",
            "type": "string"
          },
          "healthStatus": {
            "description": "Health status",
            "type": "string"
          },
          "logLevel": {
            "description": "Log level",
            "type": "string"
          },
          "numOfLogs": {
            "description": "# of Logs",
            "type": "integer"
          },
          "logFileNames": {
            "description": "List of log file name",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

Download log

GET/v11_1/applications/download/{bladeUUID}

Use this API command to download logs of the application.

URI Parameters
HideShow
appName
string (required) 

Download all logs of the specified application name.

logFileName
string (optional) 

Download log of the specified log file name.

Response  200
HideShow
Headers
Content-Type: application/octet-stream

Download snapshot log

GET/v11_1/applications/downloadsnap/{bladeUUID}

Use this API command to download snapshot logs.

Response  200
HideShow
Headers
Content-Type: application/octet-stream

Modify Log Level

PATCH/v11_1/applications

Use this API command to modify log level of specified application.

Request
HideShow
Body
{
  "applicationName": "API",
  "logLevel": "WARN"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "applicationName": {
      "description": "Application name.",
      "type": "string"
    },
    "logLevel": {
      "description": "Log level.",
      "type": "string",
      "enum": [
        "DEBUG",
        "INFO",
        "WARN",
        "ERROR"
      ]
    }
  }
}
Response  204

Connectivity Tools

Retrieve SpeedFlex Results

GET/v11_1/tool/speedflex/{wcid}

Use this API command to retrieve existing SpeedFlex test results.

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

Ping

GET/v11_1/tool/ping

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

URI Parameters
HideShow
apMac
string (required) 

MAC address of the AP running the PING test

targetIP
string (required) 

the IP address to PING

Response  200

Trace Route

GET/v11_1/tool/traceRoute

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

URI Parameters
HideShow
apMac
string (required) 

MAC address of the AP running the traceRoute test

targetIP
string (required) 

the target IP address to traceRoute

timeoutInSec
string (optional) 

Timeout in unit of seconds (Default: 30)

Response  200

SpeedFlex

POST/v11_1/tool/speedflex

Use this API command to start the SpeedFlex test.

Request
HideShow
Body
{
  "tool": "ZAP_DOWN",
  "protocol": "UDP",
  "model": "AP",
  "clientIp": "1.1.1.1",
  "clientMac": "00:11:22:33:44:55",
  "serverIp": "2.2.2.2",
  "serverMac": "11:22:33:44:55:66",
  "syspmtu": 1500
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "tool": {
      "description": "SpeedFlex tool",
      "type": "string",
      "enum": [
        "ZAP_DOWN",
        "ZAP_UP"
      ]
    },
    "protocol": {
      "description": "Protocol used in the SpeedFlex test",
      "type": "string",
      "enum": [
        "UDP"
      ]
    },
    "model": {
      "description": "Test model",
      "type": "string",
      "enum": [
        "AP",
        "CLIENT",
        "TRACE",
        "HOP",
        "NULL"
      ]
    },
    "clientIp": {
      "description": "The HTTP request remove address is used if none is specified",
      "type": "string"
    },
    "clientMac": {
      "description": "The HTTP request remove MAC address is used if none is specified",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
    },
    "serverIp": {
      "description": "The AP IP address is resolved from the client IP address if none is specified",
      "type": "string"
    },
    "serverMac": {
      "description": "The AP MAC address is resolved from the client MAC address if none is specified",
      "type": "string",
      "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
    },
    "syspmtu": {
      "description": "Packet Length",
      "type": "integer",
      "minimum": 20,
      "maximum": 25000,
      "default": 1472
    }
  },
  "required": [
    "tool",
    "protocol"
  ]
}
Response  200
HideShow
Body
{
  "wcid": "123",
  "resultId": 11,
  "uplink": 33,
  "downlink": 44,
  "latency": 23,
  "packetLoss": 21,
  "etf": 21
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "wcid": {
      "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"
    }
  }
}

SCG User

Get SCG user

GET/v11_1/users/{userId}

Get SCG user.

Response  200
HideShow
Body
{
  "id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
  "userName": "user1",
  "realName": "John",
  "phone": "123456",
  "email": "[email protected]",
  "title": "CEO",
  "enabled": 1,
  "locked": 0,
  "accountLockout": 6,
  "lockoutDuration": 30,
  "passwordExpiration": 90,
  "passwordReuse": 4,
  "sessionIdle": 30,
  "minimumPasswordLength": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "User id",
      "type": "string"
    },
    "tenantUUID": {
      "description": "Tenant id",
      "type": "string"
    },
    "domainId": {
      "description": "Domain id",
      "type": "string"
    },
    "enabled": {
      "description": "User enabled or not",
      "type": "integer",
      "enum": [
        0,
        1
      ]
    },
    "locked": {
      "description": "User locked or not (0:unlocked/1:locked)",
      "type": "integer",
      "enum": [
        0,
        1,
        2,
        3
      ]
    },
    "userName": {
      "description": "User name",
      "type": "string"
    },
    "realName": {
      "description": "User real name",
      "type": [
        "string",
        "null"
      ]
    },
    "title": {
      "description": "User title",
      "type": [
        "string",
        "null"
      ]
    },
    "phone": {
      "description": "User phone",
      "type": [
        "string",
        "null"
      ]
    },
    "email": {
      "description": "User email",
      "type": [
        "string",
        "null"
      ]
    },
    "accountLockout": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 100
    },
    "lockoutDuration": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 1440
    },
    "passwordExpiration": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 365
    },
    "passwordReuse": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 6
    },
    "sessionIdle": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 1440
    },
    "minimumPasswordLength": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 8,
      "maximum": 64
    },
    "passwordComplexityEnabled": {
      "description": "Enable the password complexity, should apply the rules as: At least one upper-case character; At least one lower-case character; At least one numeric character:At least one special character; At least 8-chars within the old password should be changed.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "minimumPasswordLifetimeEnabled": {
      "description": "Enable the password should not be changed twice within the 24 hours.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "sshPublicKeys": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "keyLabel": {
            "type": [
              "string",
              "null"
            ]
          },
          "keyContent": {
            "type": "string"
          },
          "fingerprint": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    },
    "credentialExpired": {
      "type": "boolean"
    }
  }
}

Add SCG user

POST/v11_1/users

Add SCG user.

Request
HideShow
Body
{
  "userName": "mike",
  "realName": "mike",
  "phone": "123456",
  "email": "[email protected]",
  "newPassphrase": "password",
  "title": "CTO"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "User id",
      "type": "string"
    },
    "domainId": {
      "description": "Domain id",
      "type": "string"
    },
    "newPassphrase": {
      "description": "User login passphrase",
      "type": [
        "string",
        "null"
      ]
    },
    "userName": {
      "description": "User name",
      "type": "string"
    },
    "realName": {
      "description": "User real name",
      "type": [
        "string",
        "null"
      ]
    },
    "title": {
      "description": "User title",
      "type": [
        "string",
        "null"
      ]
    },
    "phone": {
      "description": "User phone",
      "type": [
        "string",
        "null"
      ]
    },
    "email": {
      "description": "User email",
      "type": [
        "string",
        "null"
      ]
    },
    "accountLockout": {
      "description": "The number of successive failures before a lockout will occur. (System default admin ONLY)",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 100
    },
    "lockoutDuration": {
      "description": "The duration for which the account is automatically locked without administrative intervention. (System default admin ONLY)",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 1440
    },
    "passwordExpiration": {
      "description": "A simple timer that forces the administrator to change their password regularly. (System default admin ONLY)",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 365
    },
    "passwordReuse": {
      "description": "A validation the prevents reuse of the same password(s). (System default admin ONLY)",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 6
    },
    "sessionIdle": {
      "description": "A period of idle used to invalid that session. (System default admin ONLY)",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 1440
    },
    "minimumPasswordLength": {
      "description": "The minimum length of the password for the account. (System default admin ONLY)",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 8,
      "maximum": 64
    },
    "passwordComplexityEnabled": {
      "description": "Enable the password complexity, should apply the rules as: At least one upper-case character; At least one lower-case character; At least one numeric character:At least one special character; At least 8-chars within the old password should be changed.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "minimumPasswordLifetimeEnabled": {
      "description": "Enable the password should not be changed twice within the 24 hours.",
      "type": [
        "boolean",
        "null"
      ]
    }
  },
  "required": [
    "newPassphrase",
    "userName"
  ]
}
Response  200
HideShow
Body
{
  "id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the SCG user",
      "type": "string"
    }
  }
}

Query SCG users

POST/v11_1/users/query

Query SCG users. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "DOMAIN"
            ]
          },
          "value": {
            "description": "DOMAIN ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq"
            ]
          }
        },
        "required": [
          "type",
          "value"
        ]
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "userName": "user1",
      "realName": "john",
      "title": "CEO",
      "phone": "123456",
      "email": "[email protected]",
      "enabled": 1,
      "locked": 0,
      "accountLockout": 6,
      "lockoutDuration": 30,
      "passwordExpiration": 90,
      "passwordReuse": 4,
      "sessionIdle": 30,
      "minimumPasswordLength": 8,
      "tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
    },
    {
      "userName": "user1",
      "realName": "John",
      "title": "CEO",
      "phone": "123456",
      "email": "[email protected]",
      "enabled": 1,
      "locked": 0,
      "accountLockout": 6,
      "lockoutDuration": 30,
      "passwordExpiration": 90,
      "passwordReuse": 4,
      "sessionIdle": 30,
      "minimumPasswordLength": 8,
      "tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "User id",
            "type": "string"
          },
          "tenantUUID": {
            "description": "Tenant id",
            "type": "string"
          },
          "domainId": {
            "description": "Domain id",
            "type": "string"
          },
          "enabled": {
            "description": "User enabled or not",
            "type": "integer",
            "enum": [
              0,
              1
            ]
          },
          "locked": {
            "description": "User locked or not (0:unlocked/1:locked)",
            "type": "integer",
            "enum": [
              0,
              1,
              2,
              3
            ]
          },
          "userName": {
            "description": "User name",
            "type": "string"
          },
          "realName": {
            "description": "User real name",
            "type": [
              "string",
              "null"
            ]
          },
          "title": {
            "description": "User title",
            "type": [
              "string",
              "null"
            ]
          },
          "phone": {
            "description": "User phone",
            "type": [
              "string",
              "null"
            ]
          },
          "email": {
            "description": "User email",
            "type": [
              "string",
              "null"
            ]
          },
          "accountLockout": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 100
          },
          "lockoutDuration": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 1440
          },
          "passwordExpiration": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 365
          },
          "passwordReuse": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 6
          },
          "sessionIdle": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 1440
          },
          "minimumPasswordLength": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 8,
            "maximum": 64
          },
          "passwordComplexityEnabled": {
            "description": "Enable the password complexity, should apply the rules as: At least one upper-case character; At least one lower-case character; At least one numeric character:At least one special character; At least 8-chars within the old password should be changed.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "minimumPasswordLifetimeEnabled": {
            "description": "Enable the password should not be changed twice within the 24 hours.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "sshPublicKeys": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "keyLabel": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "keyContent": {
                  "type": "string"
                },
                "fingerprint": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              }
            }
          },
          "credentialExpired": {
            "type": "boolean"
          }
        }
      }
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    }
  }
}

Update SCG user

PATCH/v11_1/users/{userId}

Update SCG user.

Request
HideShow
Body
{
  "id": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "realName": "JohnJohn",
  "phone": "12345689",
  "email": "[email protected]",
  "title": "CEO",
  "passphrase": "password",
  "newPassphrase": "changeit"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "User id",
      "type": "string"
    },
    "domainId": {
      "description": "Domain id",
      "type": "string"
    },
    "passphrase": {
      "description": "User login passphrase",
      "type": [
        "string",
        "null"
      ]
    },
    "newPassphrase": {
      "description": "User new login passphrase",
      "type": [
        "string",
        "null"
      ]
    },
    "userName": {
      "description": "User name",
      "type": "string"
    },
    "realName": {
      "description": "User real name",
      "type": [
        "string",
        "null"
      ]
    },
    "title": {
      "description": "User title",
      "type": [
        "string",
        "null"
      ]
    },
    "phone": {
      "description": "User phone",
      "type": [
        "string",
        "null"
      ]
    },
    "email": {
      "description": "User email",
      "type": [
        "string",
        "null"
      ]
    },
    "accountLockout": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 100
    },
    "lockoutDuration": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 1440
    },
    "passwordExpiration": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 365
    },
    "passwordReuse": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 6
    },
    "sessionIdle": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 1440
    },
    "minimumPasswordLength": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 8,
      "maximum": 64
    },
    "passwordComplexityEnabled": {
      "description": "Enable the password complexity, should apply the rules as: At least one upper-case character; At least one lower-case character; At least one numeric character:At least one special character; At least 8-chars within the old password should be changed.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "minimumPasswordLifetimeEnabled": {
      "description": "Enable the password should not be changed twice within the 24 hours.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "sshPublicKeys": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "keyLabel": {
            "type": [
              "string",
              "null"
            ]
          },
          "keyContent": {
            "type": "string"
          },
          "fingerprint": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    }
  },
  "required": [
    "id"
  ]
}
Response  200
HideShow
Body
{
  "id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the SCG user",
      "type": "string"
    }
  }
}

Delete SCG user

DELETE/v11_1/users

Delete multiple SCG user.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200

Delete SCG user

DELETE/v11_1/users/{userId}

Delete SCG user.

Response  204
HideShow
Body
{
  "id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the SCG user",
      "type": "string"
    }
  }
}

SCG User Group

Get pre-defined roles

GET/v11_1/userGroups/roles

Get pre-defined roles.

Response  200
HideShow
Body
{
  "totalCount": 8,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "label": "Super Admin",
      "value": "SUPER_ADMIN"
    },
    {
      "label": "System Admin",
      "value": "SYSTEM_ADMIN"
    },
    {
      "label": "Read-Only System Admin",
      "value": "RO_SYSTEM_ADMIN"
    },
    {
      "label": "Network Admin",
      "value": "NETWORK_ADMIN"
    },
    {
      "label": "Read-Only Network Admin",
      "value": "RO_NETWORK_ADMIN"
    },
    {
      "label": "AP Admin",
      "value": "AP_ADMIN"
    },
    {
      "label": "Guest Pass Admin",
      "value": "GUEST_PASS_ADMIN"
    },
    {
      "label": "Custom",
      "value": "CUSTOM"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "label": {
            "description": "Role display name",
            "type": "string"
          },
          "value": {
            "description": "Role value",
            "type": "string"
          }
        }
      }
    }
  }
}

Get permission items of role

GET/v11_1/userGroups/roles/{role}/permissions

Get permission items of role.

URI Parameters
HideShow
domainId
string (optional) 
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "resource": "GUESTPASS_CATEGORY",
      "access": "FULL_ACCESS",
      "items": [
        {
          "resource": "IDENTITY_USER",
          "access": "FULL_ACCESS",
          "display": "Identity user"
        },
        {
          "resource": "GUESTPASS",
          "access": "FULL_ACCESS",
          "display": "Guestpass"
        },
        {
          "resource": "GUEST_TEMPLATE",
          "access": "FULL_ACCESS",
          "display": "Guest template"
        }
      ],
      "itemsDescription": [
        "Guest Passes",
        "Local Users"
      ],
      "display": "Guest Pass"
    }
  ],
  "extra": {
    "isSuperAdminOfDomain": true,
    "isSuperAdmin": true
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "resource": {
            "description": "Resource type",
            "type": "string"
          },
          "access": {
            "description": "Access level",
            "type": "string",
            "enum": [
              "READ",
              "MODIFY",
              "FULL_ACCESS"
            ]
          },
          "display": {
            "description": "Resource display name",
            "type": "string"
          },
          "items": {
            "description": "Resource items",
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "resource": {
                  "type": "string"
                },
                "access": {
                  "type": "string",
                  "enum": [
                    "NA",
                    "READ",
                    "MODIFY",
                    "FULL_ACCESS"
                  ]
                },
                "display": {
                  "type": "string"
                }
              }
            }
          },
          "itemsDescription": {
            "description": "Descriptions of Resource items",
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            }
          },
          "ids": {
            "description": "Resource id list",
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "extra": {
      "description": "Any additional response data.",
      "type": "object",
      "properties": {
        "isSuperAdmin": {
          "description": "whether or not current user is a 'Super Admin' that possesses all 6 permission categories with 'FULL_ACCESS'",
          "type": "boolean"
        },
        "isSuperAdminOfDomain": {
          "description": "whether or not current user is a 'Super Admin of Partner Domain' that possesses all 6 permission categories with 'FULL_ACCESS'",
          "type": "boolean"
        }
      }
    }
  }
}

Get permitted categories of current user

GET/v11_1/userGroups/currentUser/permissionCategories

Get permitted categories of current user.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "resource": "GUESTPASS_CATEGORY",
      "access": "FULL_ACCESS",
      "items": [
        {
          "resource": "IDENTITY_USER",
          "access": "FULL_ACCESS",
          "display": "Identity user"
        },
        {
          "resource": "GUESTPASS",
          "access": "FULL_ACCESS",
          "display": "Guestpass"
        },
        {
          "resource": "GUEST_TEMPLATE",
          "access": "FULL_ACCESS",
          "display": "Guest template"
        }
      ],
      "itemsDescription": [
        "Guest Passes",
        "Local Users"
      ],
      "display": "Guest Pass"
    }
  ],
  "extra": {
    "isSuperAdminOfDomain": true,
    "isSuperAdmin": true
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "resource": {
            "description": "Resource type",
            "type": "string"
          },
          "access": {
            "description": "Access level",
            "type": "string",
            "enum": [
              "READ",
              "MODIFY",
              "FULL_ACCESS"
            ]
          },
          "display": {
            "description": "Resource display name",
            "type": "string"
          },
          "items": {
            "description": "Resource items",
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "resource": {
                  "type": "string"
                },
                "access": {
                  "type": "string",
                  "enum": [
                    "NA",
                    "READ",
                    "MODIFY",
                    "FULL_ACCESS"
                  ]
                },
                "display": {
                  "type": "string"
                }
              }
            }
          },
          "itemsDescription": {
            "description": "Descriptions of Resource items",
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            }
          },
          "ids": {
            "description": "Resource id list",
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "extra": {
      "description": "Any additional response data.",
      "type": "object",
      "properties": {
        "isSuperAdmin": {
          "description": "whether or not current user is a 'Super Admin' that possesses all 6 permission categories with 'FULL_ACCESS'",
          "type": "boolean"
        },
        "isSuperAdminOfDomain": {
          "description": "whether or not current user is a 'Super Admin of Partner Domain' that possesses all 6 permission categories with 'FULL_ACCESS'",
          "type": "boolean"
        }
      }
    }
  }
}

Get SCG user group

GET/v11_1/userGroups/{userGroupId}

Get SCG user group.

URI Parameters
HideShow
includeUsers
string (optional) 
Response  200
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "group1",
  "description": "",
  "role": "AP_ADMIN",
  "accountSecurityProfileId": "a51ghnqa-1002-80a9-3a6b-ba00a0ddez9",
  "permissions": [
    {
      "resource": "AP_CATEGORY",
      "access": "MODIFY"
    },
    {
      "resource": "WLAN_CATEGORY",
      "access": "MODIFY"
    },
    {
      "resource": "DEVICE_CATEGORY",
      "access": "READ"
    }
  ],
  "resourceGroups": [
    {
      "type": "DOMAIN",
      "id": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "users": [
    {
      "userName": "user1",
      "realName": "john",
      "title": "CEO",
      "phone": "123456",
      "email": "[email protected]",
      "enabled": 1,
      "locked": 0,
      "tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "User group Id",
      "type": "string"
    },
    "tenantId": {
      "description": "Tenant Id",
      "type": [
        "string",
        "null"
      ]
    },
    "domainId": {
      "description": "Domain Id",
      "type": [
        "string",
        "null"
      ]
    },
    "name": {
      "description": "User group name",
      "type": "string"
    },
    "description": {
      "description": "User group description",
      "type": [
        "string",
        "null"
      ]
    },
    "role": {
      "description": "User group role",
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "SUPER_ADMIN",
        "SYSTEM_ADMIN",
        "NETWORK_ADMIN",
        "RO_NETWORK_ADMIN",
        "RO_SYSTEM_ADMIN",
        "AP_ADMIN",
        "GUEST_PASS_ADMIN",
        "MVNO_SUPER_ADMIN",
        "CUSTOM"
      ]
    },
    "accountSecurityProfileId": {
      "type": "string"
    },
    "accountSecurityProfileName": {
      "type": "string"
    },
    "permissions": {
      "description": "Permission list",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "resource": {
            "description": "Resource type",
            "type": "string"
          },
          "access": {
            "description": "Access level",
            "type": "string",
            "enum": [
              "READ",
              "MODIFY",
              "FULL_ACCESS"
            ]
          },
          "display": {
            "description": "Resource display name",
            "type": "string"
          },
          "ids": {
            "description": "Resource id list",
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "resourceGroups": {
      "description": "Resource group id list",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "the identifier of the SCG resource group",
            "type": "string"
          },
          "type": {
            "description": "the type of SCG resource group",
            "type": "string",
            "enum": [
              "DOMAIN",
              "ZONE",
              "APGROUP"
            ]
          },
          "name": {
            "description": "the name of the SCG resource group",
            "type": "string"
          }
        }
      }
    },
    "isFactoryDefault": {
      "type": "boolean"
    },
    "users": {
      "description": "Users in this user group",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "User id",
            "type": "string"
          },
          "tenantUUID": {
            "description": "Tenant id",
            "type": "string"
          },
          "domainId": {
            "description": "Domain id",
            "type": "string"
          },
          "enabled": {
            "description": "User enabled or not",
            "type": "integer",
            "enum": [
              0,
              1
            ]
          },
          "locked": {
            "description": "User locked or not (0:unlocked/1:locked)",
            "type": "integer",
            "enum": [
              0,
              1,
              2,
              3
            ]
          },
          "userName": {
            "description": "User name",
            "type": "string"
          },
          "realName": {
            "description": "User real name",
            "type": [
              "string",
              "null"
            ]
          },
          "title": {
            "description": "User title",
            "type": [
              "string",
              "null"
            ]
          },
          "phone": {
            "description": "User phone",
            "type": [
              "string",
              "null"
            ]
          },
          "email": {
            "description": "User email",
            "type": [
              "string",
              "null"
            ]
          },
          "accountLockout": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 100
          },
          "lockoutDuration": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 1440
          },
          "passwordExpiration": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 365
          },
          "passwordReuse": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 6
          },
          "sessionIdle": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 1440
          },
          "minimumPasswordLength": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 8,
            "maximum": 64
          },
          "passwordComplexityEnabled": {
            "description": "Enable the password complexity, should apply the rules as: At least one upper-case character; At least one lower-case character; At least one numeric character:At least one special character; At least 8-chars within the old password should be changed.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "minimumPasswordLifetimeEnabled": {
            "description": "Enable the password should not be changed twice within the 24 hours.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "sshPublicKeys": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "keyLabel": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "keyContent": {
                  "type": "string"
                },
                "fingerprint": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              }
            }
          },
          "credentialExpired": {
            "type": "boolean"
          }
        }
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  },
  "required": [
    "name",
    "role",
    "accountSecurityProfileId",
    "permissions",
    "resourceGroups"
  ]
}

Add SCG user group

POST/v11_1/userGroups

Add SCG user group.

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "group1",
  "description": "",
  "role": "AP_ADMIN",
  "accountSecurityProfileId": "a51ghnqa-1002-80a9-3a6b-ba00a0ddez9",
  "permissions": [
    {
      "resource": "AP_CATEGORY",
      "access": "MODIFY"
    },
    {
      "resource": "WLAN_CATEGORY",
      "access": "MODIFY"
    },
    {
      "resource": "DEVICE_CATEGORY",
      "access": "READ"
    }
  ],
  "resourceGroups": [
    {
      "type": "DOMAIN",
      "id": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "users": [
    {
      "userName": "user1",
      "realName": "john",
      "title": "CEO",
      "phone": "123456",
      "email": "[email protected]",
      "enabled": 1,
      "locked": 0,
      "tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "User group Id",
      "type": "string"
    },
    "tenantId": {
      "description": "Tenant Id",
      "type": [
        "string",
        "null"
      ]
    },
    "domainId": {
      "description": "Domain Id",
      "type": [
        "string",
        "null"
      ]
    },
    "name": {
      "description": "User group name",
      "type": "string"
    },
    "description": {
      "description": "User group description",
      "type": [
        "string",
        "null"
      ]
    },
    "role": {
      "description": "User group role",
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "SUPER_ADMIN",
        "SYSTEM_ADMIN",
        "NETWORK_ADMIN",
        "RO_NETWORK_ADMIN",
        "RO_SYSTEM_ADMIN",
        "AP_ADMIN",
        "GUEST_PASS_ADMIN",
        "MVNO_SUPER_ADMIN",
        "CUSTOM"
      ]
    },
    "accountSecurityProfileId": {
      "type": "string"
    },
    "accountSecurityProfileName": {
      "type": "string"
    },
    "permissions": {
      "description": "Permission list",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "resource": {
            "description": "Resource type",
            "type": "string"
          },
          "access": {
            "description": "Access level",
            "type": "string",
            "enum": [
              "READ",
              "MODIFY",
              "FULL_ACCESS"
            ]
          },
          "display": {
            "description": "Resource display name",
            "type": "string"
          },
          "ids": {
            "description": "Resource id list",
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "resourceGroups": {
      "description": "Resource group id list",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "the identifier of the SCG resource group",
            "type": "string"
          },
          "type": {
            "description": "the type of SCG resource group",
            "type": "string",
            "enum": [
              "DOMAIN",
              "ZONE",
              "APGROUP"
            ]
          },
          "name": {
            "description": "the name of the SCG resource group",
            "type": "string"
          }
        }
      }
    },
    "isFactoryDefault": {
      "type": "boolean"
    },
    "users": {
      "description": "Users in this user group",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "User id",
            "type": "string"
          },
          "tenantUUID": {
            "description": "Tenant id",
            "type": "string"
          },
          "domainId": {
            "description": "Domain id",
            "type": "string"
          },
          "enabled": {
            "description": "User enabled or not",
            "type": "integer",
            "enum": [
              0,
              1
            ]
          },
          "locked": {
            "description": "User locked or not (0:unlocked/1:locked)",
            "type": "integer",
            "enum": [
              0,
              1,
              2,
              3
            ]
          },
          "userName": {
            "description": "User name",
            "type": "string"
          },
          "realName": {
            "description": "User real name",
            "type": [
              "string",
              "null"
            ]
          },
          "title": {
            "description": "User title",
            "type": [
              "string",
              "null"
            ]
          },
          "phone": {
            "description": "User phone",
            "type": [
              "string",
              "null"
            ]
          },
          "email": {
            "description": "User email",
            "type": [
              "string",
              "null"
            ]
          },
          "accountLockout": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 100
          },
          "lockoutDuration": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 1440
          },
          "passwordExpiration": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 365
          },
          "passwordReuse": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 6
          },
          "sessionIdle": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 1440
          },
          "minimumPasswordLength": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 8,
            "maximum": 64
          },
          "passwordComplexityEnabled": {
            "description": "Enable the password complexity, should apply the rules as: At least one upper-case character; At least one lower-case character; At least one numeric character:At least one special character; At least 8-chars within the old password should be changed.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "minimumPasswordLifetimeEnabled": {
            "description": "Enable the password should not be changed twice within the 24 hours.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "sshPublicKeys": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "keyLabel": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "keyContent": {
                  "type": "string"
                },
                "fingerprint": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              }
            }
          },
          "credentialExpired": {
            "type": "boolean"
          }
        }
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  },
  "required": [
    "name",
    "role",
    "accountSecurityProfileId",
    "permissions",
    "resourceGroups"
  ]
}
Response  201
HideShow
Body
{
  "id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the SCG user group",
      "type": "string"
    }
  }
}

Query user groups

POST/v11_1/userGroups/query

Query user groups. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "DOMAIN"
            ]
          },
          "value": {
            "description": "DOMAIN ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq"
            ]
          }
        },
        "required": [
          "type",
          "value"
        ]
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "name": "group1",
      "description": "",
      "role": "AP_ADMIN",
      "permissions": [
        {
          "resource": "AP_CATEGORY",
          "access": "MODIFY"
        },
        {
          "resource": "WLAN_CATEGORY",
          "access": "MODIFY"
        },
        {
          "resource": "DEVICE_CATEGORY",
          "access": "READ"
        }
      ],
      "resourceGroups": [
        {
          "type": "DOMAIN",
          "id": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
        }
      ],
      "users": [
        {
          "userName": "user1",
          "realName": "john",
          "title": "CEO",
          "phone": "123456",
          "email": "[email protected]",
          "enabled": 1,
          "locked": 0,
          "tenantUUID": "839f87c6-d116-497e-afce-aa8157abd30c",
          "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
          "id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "User group Id",
            "type": "string"
          },
          "tenantId": {
            "description": "Tenant Id",
            "type": [
              "string",
              "null"
            ]
          },
          "domainId": {
            "description": "Domain Id",
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "description": "User group name",
            "type": "string"
          },
          "description": {
            "description": "User group description",
            "type": [
              "string",
              "null"
            ]
          },
          "role": {
            "description": "User group role",
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "SUPER_ADMIN",
              "SYSTEM_ADMIN",
              "NETWORK_ADMIN",
              "RO_NETWORK_ADMIN",
              "RO_SYSTEM_ADMIN",
              "AP_ADMIN",
              "GUEST_PASS_ADMIN",
              "MVNO_SUPER_ADMIN",
              "CUSTOM"
            ]
          },
          "accountSecurityProfileId": {
            "type": "string"
          },
          "accountSecurityProfileName": {
            "type": "string"
          },
          "permissions": {
            "description": "Permission list",
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "resource": {
                  "description": "Resource type",
                  "type": "string"
                },
                "access": {
                  "description": "Access level",
                  "type": "string",
                  "enum": [
                    "READ",
                    "MODIFY",
                    "FULL_ACCESS"
                  ]
                },
                "display": {
                  "description": "Resource display name",
                  "type": "string"
                },
                "ids": {
                  "description": "Resource id list",
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "resourceGroups": {
            "description": "Resource group id list",
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "id": {
                  "description": "the identifier of the SCG resource group",
                  "type": "string"
                },
                "type": {
                  "description": "the type of SCG resource group",
                  "type": "string",
                  "enum": [
                    "DOMAIN",
                    "ZONE",
                    "APGROUP"
                  ]
                },
                "name": {
                  "description": "the name of the SCG resource group",
                  "type": "string"
                }
              }
            }
          },
          "isFactoryDefault": {
            "type": "boolean"
          },
          "users": {
            "description": "Users in this user group",
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "id": {
                  "description": "User id",
                  "type": "string"
                },
                "tenantUUID": {
                  "description": "Tenant id",
                  "type": "string"
                },
                "domainId": {
                  "description": "Domain id",
                  "type": "string"
                },
                "enabled": {
                  "description": "User enabled or not",
                  "type": "integer",
                  "enum": [
                    0,
                    1
                  ]
                },
                "locked": {
                  "description": "User locked or not (0:unlocked/1:locked)",
                  "type": "integer",
                  "enum": [
                    0,
                    1,
                    2,
                    3
                  ]
                },
                "userName": {
                  "description": "User name",
                  "type": "string"
                },
                "realName": {
                  "description": "User real name",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "title": {
                  "description": "User title",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "phone": {
                  "description": "User phone",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "email": {
                  "description": "User email",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "accountLockout": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "minimum": 1,
                  "maximum": 100
                },
                "lockoutDuration": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "minimum": 1,
                  "maximum": 1440
                },
                "passwordExpiration": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "minimum": 1,
                  "maximum": 365
                },
                "passwordReuse": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "minimum": 1,
                  "maximum": 6
                },
                "sessionIdle": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "minimum": 1,
                  "maximum": 1440
                },
                "minimumPasswordLength": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "minimum": 8,
                  "maximum": 64
                },
                "passwordComplexityEnabled": {
                  "description": "Enable the password complexity, should apply the rules as: At least one upper-case character; At least one lower-case character; At least one numeric character:At least one special character; At least 8-chars within the old password should be changed.",
                  "type": [
                    "boolean",
                    "null"
                  ]
                },
                "minimumPasswordLifetimeEnabled": {
                  "description": "Enable the password should not be changed twice within the 24 hours.",
                  "type": [
                    "boolean",
                    "null"
                  ]
                },
                "sshPublicKeys": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                      "keyLabel": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "keyContent": {
                        "type": "string"
                      },
                      "fingerprint": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    }
                  }
                },
                "credentialExpired": {
                  "type": "boolean"
                }
              }
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        },
        "required": [
          "name",
          "role",
          "accountSecurityProfileId",
          "permissions",
          "resourceGroups"
        ]
      }
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    }
  }
}

Update user groups

PATCH/v11_1/userGroups/{userGroupId}

Update user groups.

Request
HideShow
Body
{
  "id": "1c942d00-4f36-11e6-8512-0a0027000000",
  "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "patchScgUserGroup",
  "description": "patchScgUserGroup",
  "role": "null",
  "accountSecurityProfileId": "a51ghnqa-1002-80a9-3a6b-ba00a0ddez9",
  "permissions": [
    {
      "resource": "AP_CATEGORY",
      "access": "MODIFY"
    },
    {
      "resource": "WLAN_CATEGORY",
      "access": "MODIFY"
    },
    {
      "resource": "DEVICE_CATEGORY",
      "access": "READ"
    }
  ],
  "resourceGroups": [
    {
      "type": "DOMAIN",
      "id": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "users": [
    {
      "id": "03281745-18b8-41c5-bc7a-859ec768da38"
    },
    {
      "id": "3673f6ed-4e71-4fb4-b059-ce1356b7dd42"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "tenantId": {
      "type": [
        "string",
        "null"
      ]
    },
    "domainId": {
      "type": [
        "string",
        "null"
      ]
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "role": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "SUPER_ADMIN",
        "SYSTEM_ADMIN",
        "NETWORK_ADMIN",
        "RO_NETWORK_ADMIN",
        "RO_SYSTEM_ADMIN",
        "AP_ADMIN",
        "GUEST_PASS_ADMIN",
        "MVNO_SUPER_ADMIN",
        "CUSTOM"
      ]
    },
    "accountSecurityProfileId": {
      "type": "string"
    },
    "permissions": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "resource": {
            "description": "Resource type",
            "type": "string"
          },
          "access": {
            "description": "Access level",
            "type": "string",
            "enum": [
              "READ",
              "MODIFY",
              "FULL_ACCESS"
            ]
          },
          "display": {
            "description": "Resource display name",
            "type": "string"
          },
          "ids": {
            "description": "Resource id list",
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "resourceGroups": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "the identifier of the SCG resource group",
            "type": "string"
          },
          "type": {
            "description": "the type of SCG resource group",
            "type": "string",
            "enum": [
              "DOMAIN",
              "ZONE",
              "APGROUP"
            ]
          },
          "name": {
            "description": "the name of the SCG resource group",
            "type": "string"
          }
        }
      }
    },
    "users": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "User id",
            "type": "string"
          },
          "tenantUUID": {
            "description": "Tenant id",
            "type": "string"
          },
          "domainId": {
            "description": "Domain id",
            "type": "string"
          },
          "enabled": {
            "description": "User enabled or not",
            "type": "integer",
            "enum": [
              0,
              1
            ]
          },
          "locked": {
            "description": "User locked or not (0:unlocked/1:locked)",
            "type": "integer",
            "enum": [
              0,
              1,
              2,
              3
            ]
          },
          "userName": {
            "description": "User name",
            "type": "string"
          },
          "realName": {
            "description": "User real name",
            "type": [
              "string",
              "null"
            ]
          },
          "title": {
            "description": "User title",
            "type": [
              "string",
              "null"
            ]
          },
          "phone": {
            "description": "User phone",
            "type": [
              "string",
              "null"
            ]
          },
          "email": {
            "description": "User email",
            "type": [
              "string",
              "null"
            ]
          },
          "accountLockout": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 100
          },
          "lockoutDuration": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 1440
          },
          "passwordExpiration": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 365
          },
          "passwordReuse": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 6
          },
          "sessionIdle": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 1440
          },
          "minimumPasswordLength": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 8,
            "maximum": 64
          },
          "passwordComplexityEnabled": {
            "description": "Enable the password complexity, should apply the rules as: At least one upper-case character; At least one lower-case character; At least one numeric character:At least one special character; At least 8-chars within the old password should be changed.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "minimumPasswordLifetimeEnabled": {
            "description": "Enable the password should not be changed twice within the 24 hours.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "sshPublicKeys": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "keyLabel": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "keyContent": {
                  "type": "string"
                },
                "fingerprint": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              }
            }
          },
          "credentialExpired": {
            "type": "boolean"
          }
        }
      }
    },
    "createDateTime": {
      "type": "integer"
    },
    "modifiedDateTime": {
      "type": "integer"
    },
    "creatorId": {
      "type": "string"
    },
    "modifierId": {
      "type": "string"
    },
    "creatorUsername": {
      "type": "string"
    },
    "modifierUsername": {
      "type": "string"
    }
  }
}
Response  204
HideShow
Body
{
  "id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the SCG user group",
      "type": "string"
    }
  }
}

Delete SCG user group

DELETE/v11_1/userGroups

Delete multiple SCG user group.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200

Delete SCG user group

DELETE/v11_1/userGroups/{userGroupId}

Delete SCG user group.

Response  204
HideShow
Body
{
  "id": "7cdf1ef6-0d74-82c6-7214-a0d9c046853e"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the SCG user group",
      "type": "string"
    }
  }
}

Account Security

Get the account security profile by id

GET/v11_1/accountSecurity/{id}

Use this API command to retrieve the specific account security profile.

Request
HideShow
Body
{
  "id": "05f0503b-cfd9-414e-b37d-72a96f0f4288"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile id",
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "domainId": {
      "type": "string"
    },
    "tenantId": {
      "type": "string"
    },
    "accountLockout": {
      "type": "integer"
    },
    "attemptsLockoutTimes": {
      "type": "integer"
    },
    "attemptsLockoutPeriod": {
      "type": "integer"
    },
    "lockoutDuration": {
      "type": "integer"
    },
    "attemptsLockEnabled": {
      "type": "boolean"
    },
    "passwordExpiration": {
      "type": "integer"
    },
    "passwordReuse": {
      "type": "integer"
    },
    "sessionIdle": {
      "type": "integer"
    },
    "twoFactorAuthEnabled": {
      "type": "boolean"
    },
    "disableInactiveAccounts": {
      "type": "integer"
    },
    "minimumPasswordLength": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 8,
      "maximum": 64
    },
    "passwordComplexityEnabled": {
      "type": "boolean"
    },
    "minimumPasswordLifetimeEnabled": {
      "type": "boolean"
    }
  }
}

Get the account security profiles

GET/v11_1/accountSecurity

Use this API command to get account security profiles.

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Profile id",
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    }
  }
}

Create the account security profile.

POST/v11_1/accountSecurity

Use this API command to create the account security proile.

Request
HideShow
Body
{
  "name": "sample",
  "description": "Test",
  "accountLockout": 6,
  "lockoutDuration": 30,
  "passwordExpiration": 90,
  "passwordReuse": 4,
  "sessionIdle": 30,
  "twoFactorAuthEnabled": false,
  "disableInactiveAccounts": 100,
  "minimumPasswordLength": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Profile name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "accountLockout": {
      "description": "The number of successive failures before a lockout will occur.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "lockoutDuration": {
      "description": "The duration for which the account is automatically locked without administrative intervention.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1440
    },
    "attemptsLockEnabled": {
      "type": "boolean"
    },
    "attemptsLockoutTimes": {
      "description": "The attempts times.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "attemptsLockoutPeriod": {
      "description": "A period of attempts times.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1440
    },
    "passwordExpiration": {
      "description": "A simple timer that forces the administrator to change their password regularly.",
      "type": "integer",
      "minimum": 1,
      "maximum": 365
    },
    "passwordReuse": {
      "description": "A validation the prevents reuse of the same password(s).",
      "type": "integer",
      "minimum": 1,
      "maximum": 6
    },
    "sessionIdle": {
      "description": "A period of idle used to invalid that session.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1440
    },
    "twoFactorAuthEnabled": {
      "description": "Enable the two-factor authentication. (This configuration can only be enabled from Web GUI.)",
      "type": "boolean"
    },
    "disableInactiveAccounts": {
      "description": "A period in a inactive status used to lockout these accounts.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    },
    "domainId": {
      "description": "Domain id",
      "type": "string"
    },
    "minimumPasswordLength": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 8,
      "maximum": 64
    },
    "passwordComplexityEnabled": {
      "description": "Control password complexity mechanism.",
      "type": "boolean"
    },
    "minimumPasswordLifetimeEnabled": {
      "description": "Control minimum password life time.",
      "type": "boolean"
    }
  }
}
Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}

Modify the account security profile

PUT/v11_1/accountSecurity/{id}

Use this API command to modify the specific account security profile.

Request
HideShow
Body
{
  "name": "sample",
  "description": "Test",
  "accountLockout": 5,
  "lockoutDuration": 20,
  "passwordExpiration": 100,
  "passwordReuse": 6,
  "sessionIdle": 30,
  "twoFactorAuthEnabled": false,
  "disableInactiveAccounts": 100,
  "minimumPasswordLength": 10
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Profile name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "accountLockout": {
      "description": "The number of successive failures before a lockout will occur.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "lockoutDuration": {
      "description": "The duration for which the account is automatically locked without administrative intervention.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1440
    },
    "attemptsLockEnabled": {
      "type": "boolean"
    },
    "attemptsLockoutTimes": {
      "description": "The attempts times.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "attemptsLockoutPeriod": {
      "description": "A period of attempts times.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1440
    },
    "passwordExpiration": {
      "description": "A simple timer that forces the administrator to change their password regularly.",
      "type": "integer",
      "minimum": 1,
      "maximum": 365
    },
    "passwordReuse": {
      "description": "A validation the prevents reuse of the same password(s).",
      "type": "integer",
      "minimum": 1,
      "maximum": 6
    },
    "sessionIdle": {
      "description": "A period of idle used to invalid that session.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1440
    },
    "twoFactorAuthEnabled": {
      "description": "Enable the two-factor authentication. (This configuration can only be enabled from Web GUI.)",
      "type": "boolean"
    },
    "disableInactiveAccounts": {
      "description": "A period in a inactive status used to lockout these accounts.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    },
    "domainId": {
      "type": "string"
    },
    "minimumPasswordLength": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 8,
      "maximum": 64
    },
    "passwordComplexityEnabled": {
      "description": "Control password complexity mechanism.",
      "type": "boolean"
    },
    "minimumPasswordLifetimeEnabled": {
      "description": "Control minimum password life time.",
      "type": "boolean"
    }
  }
}
Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}

Modify

PATCH/v11_1/accountSecurity/{id}

Use this API command to modify the specific account security profile.

Request
HideShow
Body
{
  "name": "sample",
  "description": "Test",
  "accountLockout": 5,
  "lockoutDuration": 20,
  "passwordExpiration": 100,
  "passwordReuse": 6,
  "sessionIdle": 30,
  "twoFactorAuthEnabled": false,
  "disableInactiveAccounts": 100,
  "minimumPasswordLength": 10
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Profile name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "accountLockout": {
      "description": "The number of successive failures before a lockout will occur.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "lockoutDuration": {
      "description": "The duration for which the account is automatically locked without administrative intervention.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1440
    },
    "attemptsLockEnabled": {
      "type": "boolean"
    },
    "attemptsLockoutTimes": {
      "description": "The attempts times.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "attemptsLockoutPeriod": {
      "description": "A period of attempts times.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1440
    },
    "passwordExpiration": {
      "description": "A simple timer that forces the administrator to change their password regularly.",
      "type": "integer",
      "minimum": 1,
      "maximum": 365
    },
    "passwordReuse": {
      "description": "A validation the prevents reuse of the same password(s).",
      "type": "integer",
      "minimum": 1,
      "maximum": 6
    },
    "sessionIdle": {
      "description": "A period of idle used to invalid that session.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1440
    },
    "twoFactorAuthEnabled": {
      "description": "Enable the two-factor authentication. (This configuration can only be enabled from Web GUI.)",
      "type": "boolean"
    },
    "disableInactiveAccounts": {
      "description": "A period in a inactive status used to lockout these accounts.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    },
    "domainId": {
      "type": "string"
    },
    "minimumPasswordLength": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 8,
      "maximum": 64
    },
    "passwordComplexityEnabled": {
      "description": "Control password complexity mechanism.",
      "type": "boolean"
    },
    "minimumPasswordLifetimeEnabled": {
      "description": "Control minimum password life time.",
      "type": "boolean"
    }
  }
}
Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}

Delete the account security profile

DELETE/v11_1/accountSecurity

Use this API command to selete the account security profile.

Request
HideShow
Body
{
  "idList": [
    "eac50e51-4a63-11e7-a68a-0a0027000000",
    "1b4950d1-49d9-11e7-a68a-0a0027000000"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200

Delete the account security profile by id

DELETE/v11_1/accountSecurity/{id}

Use this API command to delete the account security profile by id.

Request
HideShow
Body
{
  "id": "05f0503b-cfd9-414e-b37d-72a96f0f4288"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile id",
      "type": "string"
    }
  }
}
Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}

IndoorMap

Get indoor map list

GET/v11_1/maps

Use this API command to get indoor map list.

URI Parameters
HideShow
groupId
string (required) 
groupType
string (required) 
Response  200
HideShow
Body
{
  "totalCount": 3,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "key": "93b59041-1e97-4048-be43-4909553c78b6",
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "name": "DemoMap",
      "description": "",
      "imageFileName": "map.png",
      "orientation": "HORIZONTAL",
      "address": "350 W Java Dr Sunnyvale, CA 94089",
      "longitude": -122.0196,
      "latitude": 37.41121,
      "zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "groupType": "ZONE",
      "scale": {
        "a": {
          "x": 341.99716,
          "y": 224.01706
        },
        "b": {
          "x": 418.99716,
          "y": 202.01706
        },
        "distance": 2,
        "unit": "CM"
      }
    },
    {
      "key": "3608b441-256a-11e6-b2ac-0a0027000000",
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "name": "MapName",
      "description": "Description",
      "imageFileName": "z82FU.gif",
      "orientation": "HORIZONTAL",
      "address": "Location",
      "longitude": 121.57141,
      "latitude": 25.07858,
      "zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "groupType": "ZONE",
      "scale": {
        "a": {
          "x": 252.6392,
          "y": 187.01137
        },
        "b": {
          "x": 360.63922,
          "y": 184.01137
        },
        "distance": 3,
        "unit": "M"
      }
    },
    {
      "key": "c9167ee0-2568-11e6-b2ac-0a0027000000",
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "name": "name",
      "description": "",
      "imageFileName": "download.jpg",
      "orientation": "HORIZONTAL",
      "address": "Address",
      "longitude": 121.57141,
      "latitude": 25.07858,
      "zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "groupType": "ZONE",
      "scale": {
        "a": {
          "x": 279.0199,
          "y": 160.01706
        },
        "b": {
          "x": 413.0199,
          "y": 159.01706
        },
        "distance": 5,
        "unit": "MM"
      }
    }
  ],
  "extra": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total indoor maps count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more indoor maps after the list that is currently displayed",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first indoorMapList returned out of the complete indoor maps list",
      "type": "integer"
    },
    "extra": {
      "description": "extra information for indoor map",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "zoneId": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "groupType": {
            "type": "string",
            "enum": [
              "SYSTEM",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP"
            ]
          },
          "address": {
            "type": "string"
          },
          "latitude": {
            "type": "number"
          },
          "longitude": {
            "type": "number"
          },
          "orientation": {
            "type": "string",
            "enum": [
              "HORIZONTAL",
              "VERTICAL"
            ]
          },
          "imageFileName": {
            "type": "string"
          },
          "domainId": {
            "type": "string"
          },
          "tenantId": {
            "type": "string"
          },
          "scale": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "a": {
                "description": "point a",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "x": {
                    "description": "x",
                    "type": "number"
                  },
                  "y": {
                    "description": "y",
                    "type": "number"
                  }
                }
              },
              "b": {
                "description": "point b",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "x": {
                    "description": "x",
                    "type": "number"
                  },
                  "y": {
                    "description": "y",
                    "type": "number"
                  }
                }
              },
              "distance": {
                "description": "distance",
                "type": "number"
              },
              "unit": {
                "description": "unit",
                "type": "string",
                "enum": [
                  "MM",
                  "CM",
                  "M",
                  "Foot",
                  "Yard"
                ]
              }
            }
          },
          "apGroupId": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "description",
          "groupType"
        ]
      }
    }
  }
}

Get IndoorMap

GET/v11_1/maps/{indoorMapId}

Use this API command to get indoor maps.

Response  200
HideShow
Body
{
  "name": "MapName",
  "description": "Description",
  "address": "Location",
  "latitude": 25.07858,
  "longitude": 121.57141,
  "orientation": "HORIZONTAL",
  "imageData": "The base64 encoded data of image",
  "imageFileName": "map.jpg",
  "scale": {
    "a": {
      "x": 252.6392059326172,
      "y": 187.01136779785156
    },
    "b": {
      "x": 360.63922119140625,
      "y": 184.01136779785156
    },
    "distance": 3,
    "unit": "M"
  },
  "groupType": "ZONE",
  "zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
  "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "id",
      "type": "string"
    },
    "zoneId": {
      "description": "zoneId",
      "type": "string"
    },
    "name": {
      "description": "name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "groupType": {
      "description": "group Type",
      "type": "string",
      "enum": [
        "SYSTEM",
        "DOMAIN",
        "ZONE",
        "THIRD_PARTY_ZONE",
        "APGROUP"
      ]
    },
    "address": {
      "description": "address",
      "type": "string"
    },
    "latitude": {
      "description": "latitude",
      "type": "number"
    },
    "longitude": {
      "description": "longitude",
      "type": "number"
    },
    "orientation": {
      "description": "orientation",
      "type": "string",
      "enum": [
        "HORIZONTAL",
        "VERTICAL"
      ]
    },
    "imageData": {
      "description": "imageData",
      "type": "string"
    },
    "imageFileName": {
      "description": "imageFileName",
      "type": "string"
    },
    "domainId": {
      "description": "domainId",
      "type": "string"
    },
    "tenantId": {
      "description": "tenantId",
      "type": "string"
    },
    "scale": {
      "description": "scale",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "a": {
          "description": "point a",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "x": {
              "description": "x",
              "type": "number"
            },
            "y": {
              "description": "y",
              "type": "number"
            }
          }
        },
        "b": {
          "description": "point b",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "x": {
              "description": "x",
              "type": "number"
            },
            "y": {
              "description": "y",
              "type": "number"
            }
          }
        },
        "distance": {
          "description": "distance",
          "type": "number"
        },
        "unit": {
          "description": "unit",
          "type": "string",
          "enum": [
            "MM",
            "CM",
            "M",
            "Foot",
            "Yard"
          ]
        }
      }
    },
    "apGroupId": {
      "description": "apGroupId",
      "type": "string"
    }
  },
  "required": [
    "name",
    "description",
    "groupType"
  ]
}

Query IndoorMap

POST/v11_1/maps/query

Use this API command to query indoorMap. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 3,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "key": "93b59041-1e97-4048-be43-4909553c78b6",
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "name": "DemoMap",
      "description": "",
      "imageFileName": "map.png",
      "orientation": "HORIZONTAL",
      "address": "350 W Java Dr Sunnyvale, CA 94089",
      "longitude": -122.0196,
      "latitude": 37.41121,
      "zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "groupType": "ZONE",
      "scale": {
        "a": {
          "x": 341.99716,
          "y": 224.01706
        },
        "b": {
          "x": 418.99716,
          "y": 202.01706
        },
        "distance": 2,
        "unit": "CM"
      }
    },
    {
      "key": "3608b441-256a-11e6-b2ac-0a0027000000",
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "name": "MapName",
      "description": "Description",
      "imageFileName": "z82FU.gif",
      "orientation": "HORIZONTAL",
      "address": "Location",
      "longitude": 121.57141,
      "latitude": 25.07858,
      "zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "groupType": "ZONE",
      "scale": {
        "a": {
          "x": 252.6392,
          "y": 187.01137
        },
        "b": {
          "x": 360.63922,
          "y": 184.01137
        },
        "distance": 3,
        "unit": "M"
      }
    },
    {
      "key": "c9167ee0-2568-11e6-b2ac-0a0027000000",
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "name": "name",
      "description": "",
      "imageFileName": "download.jpg",
      "orientation": "HORIZONTAL",
      "address": "Address",
      "longitude": 121.57141,
      "latitude": 25.07858,
      "zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "groupType": "ZONE",
      "scale": {
        "a": {
          "x": 279.0199,
          "y": 160.01706
        },
        "b": {
          "x": 413.0199,
          "y": 159.01706
        },
        "distance": 5,
        "unit": "MM"
      }
    }
  ],
  "extra": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total indoor maps count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more indoor maps after the list that is currently displayed",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first indoorMapList returned out of the complete indoor maps list",
      "type": "integer"
    },
    "extra": {
      "description": "extra information for indoor map",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "zoneId": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "groupType": {
            "type": "string",
            "enum": [
              "SYSTEM",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP"
            ]
          },
          "address": {
            "type": "string"
          },
          "latitude": {
            "type": "number"
          },
          "longitude": {
            "type": "number"
          },
          "orientation": {
            "type": "string",
            "enum": [
              "HORIZONTAL",
              "VERTICAL"
            ]
          },
          "imageFileName": {
            "type": "string"
          },
          "domainId": {
            "type": "string"
          },
          "tenantId": {
            "type": "string"
          },
          "scale": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "a": {
                "description": "point a",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "x": {
                    "description": "x",
                    "type": "number"
                  },
                  "y": {
                    "description": "y",
                    "type": "number"
                  }
                }
              },
              "b": {
                "description": "point b",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "x": {
                    "description": "x",
                    "type": "number"
                  },
                  "y": {
                    "description": "y",
                    "type": "number"
                  }
                }
              },
              "distance": {
                "description": "distance",
                "type": "number"
              },
              "unit": {
                "description": "unit",
                "type": "string",
                "enum": [
                  "MM",
                  "CM",
                  "M",
                  "Foot",
                  "Yard"
                ]
              }
            }
          },
          "apGroupId": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "description",
          "groupType"
        ]
      }
    }
  }
}

Create IndoorMap

POST/v11_1/maps

Use this API command to create indoorMap.

Request
HideShow
Body
{
  "name": "MapName",
  "description": "Description",
  "address": "Location",
  "latitude": 25.07858,
  "longitude": 121.57141,
  "orientation": "HORIZONTAL",
  "imageData": "The base64 encoded data of image",
  "imageFileName": "map.jpg",
  "scale": {
    "a": {
      "x": 252.6392059326172,
      "y": 187.01136779785156
    },
    "b": {
      "x": 360.63922119140625,
      "y": 184.01136779785156
    },
    "distance": 3,
    "unit": "M"
  },
  "groupType": "ZONE",
  "zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
  "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "id",
      "type": "string"
    },
    "zoneId": {
      "description": "zoneId",
      "type": "string"
    },
    "name": {
      "description": "name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "groupType": {
      "description": "group Type",
      "type": "string",
      "enum": [
        "SYSTEM",
        "DOMAIN",
        "ZONE",
        "THIRD_PARTY_ZONE",
        "APGROUP"
      ]
    },
    "address": {
      "description": "address",
      "type": "string"
    },
    "latitude": {
      "description": "latitude",
      "type": "number"
    },
    "longitude": {
      "description": "longitude",
      "type": "number"
    },
    "orientation": {
      "description": "orientation",
      "type": "string",
      "enum": [
        "HORIZONTAL",
        "VERTICAL"
      ]
    },
    "imageData": {
      "description": "imageData",
      "type": "string"
    },
    "imageFileName": {
      "description": "imageFileName",
      "type": "string"
    },
    "domainId": {
      "description": "domainId",
      "type": "string"
    },
    "tenantId": {
      "description": "tenantId",
      "type": "string"
    },
    "scale": {
      "description": "scale",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "a": {
          "description": "point a",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "x": {
              "description": "x",
              "type": "number"
            },
            "y": {
              "description": "y",
              "type": "number"
            }
          }
        },
        "b": {
          "description": "point b",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "x": {
              "description": "x",
              "type": "number"
            },
            "y": {
              "description": "y",
              "type": "number"
            }
          }
        },
        "distance": {
          "description": "distance",
          "type": "number"
        },
        "unit": {
          "description": "unit",
          "type": "string",
          "enum": [
            "MM",
            "CM",
            "M",
            "Foot",
            "Yard"
          ]
        }
      }
    },
    "apGroupId": {
      "description": "apGroupId",
      "type": "string"
    }
  },
  "required": [
    "name",
    "description",
    "groupType"
  ]
}
Response  201
HideShow
Body
{
  "id": "c9167ee0-2568-11e6-b2ac-0a0027000000",
  "name": "mapName"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the indoor map",
      "type": "string"
    },
    "name": {
      "description": "the name of the indoor map",
      "type": "string"
    }
  }
}

Put Aps in indoor map

PUT/v11_1/maps/{indoorMapId}/aps

Use this API command to put Aps in indoor map.

Request
HideShow
Body
[
  {
    "mac": "AB:CD:00:00:00:27",
    "indoorMapXy": {
      "x": 142.16,
      "y": 89.61
    }
  }
]
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "mac": {
        "description": "the identifier of the create object",
        "type": "string"
      },
      "indoorMapXy": {
        "description": "location of this AP",
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "x": {
            "description": "x",
            "type": "number"
          },
          "y": {
            "description": "y",
            "type": "number"
          }
        }
      }
    }
  }
}
Response  204
HideShow
Body
{
  "id": "c9167ee0-2568-11e6-b2ac-0a0027000000",
  "name": "mapName"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the indoor map",
      "type": "string"
    },
    "name": {
      "description": "the name of the indoor map",
      "type": "string"
    }
  }
}

Update indoor map

PATCH/v11_1/maps/{indoorMapId}

Use this API command to update specific indoor map.

Request
HideShow
Body
{
  "name": "MapName",
  "description": "Description",
  "address": "Location",
  "latitude": 25.07858,
  "longitude": 121.57141,
  "orientation": "HORIZONTAL",
  "imageData": "The base64 encoded data of image",
  "imageFileName": "map.jpg",
  "scale": {
    "a": {
      "x": 252.6392059326172,
      "y": 187.01136779785156
    },
    "b": {
      "x": 360.63922119140625,
      "y": 184.01136779785156
    },
    "distance": 3,
    "unit": "M"
  },
  "groupType": "ZONE",
  "zoneId": "0181b322-3b3f-43a4-8e55-00c44d0d6c4f",
  "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "id",
      "type": "string"
    },
    "zoneId": {
      "description": "zoneId",
      "type": "string"
    },
    "name": {
      "description": "name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "description",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "groupType": {
      "description": "group Type",
      "type": "string",
      "enum": [
        "SYSTEM",
        "DOMAIN",
        "ZONE",
        "THIRD_PARTY_ZONE",
        "APGROUP"
      ]
    },
    "address": {
      "description": "address",
      "type": "string"
    },
    "latitude": {
      "description": "latitude",
      "type": "number"
    },
    "longitude": {
      "description": "longitude",
      "type": "number"
    },
    "orientation": {
      "description": "orientation",
      "type": "string",
      "enum": [
        "HORIZONTAL",
        "VERTICAL"
      ]
    },
    "imageData": {
      "description": "imageData",
      "type": "string"
    },
    "imageFileName": {
      "description": "imageFileName",
      "type": "string"
    },
    "domainId": {
      "description": "domainId",
      "type": "string"
    },
    "tenantId": {
      "description": "tenantId",
      "type": "string"
    },
    "scale": {
      "description": "scale",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "a": {
          "description": "point a",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "x": {
              "description": "x",
              "type": "number"
            },
            "y": {
              "description": "y",
              "type": "number"
            }
          }
        },
        "b": {
          "description": "point b",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "x": {
              "description": "x",
              "type": "number"
            },
            "y": {
              "description": "y",
              "type": "number"
            }
          }
        },
        "distance": {
          "description": "distance",
          "type": "number"
        },
        "unit": {
          "description": "unit",
          "type": "string",
          "enum": [
            "MM",
            "CM",
            "M",
            "Foot",
            "Yard"
          ]
        }
      }
    },
    "apGroupId": {
      "description": "apGroupId",
      "type": "string"
    }
  },
  "required": [
    "name",
    "description",
    "groupType"
  ]
}
Response  204
HideShow
Body
{
  "id": "c9167ee0-2568-11e6-b2ac-0a0027000000",
  "name": "mapName"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the indoor map",
      "type": "string"
    },
    "name": {
      "description": "the name of the indoor map",
      "type": "string"
    }
  }
}

Delete IndoorMap

DELETE/v11_1/maps/{indoorMapId}

Use this API command to delete indoor map.

Response  204
HideShow
Body
{
  "id": "c9167ee0-2568-11e6-b2ac-0a0027000000",
  "name": "mapName"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "the identifier of the indoor map",
      "type": "string"
    },
    "name": {
      "description": "the name of the indoor map",
      "type": "string"
    }
  }
}

Query With Filter

Query Radius Proxy Stats

POST/v11_1/query/radiusProxy/stats

Use this API command to retrieve a list of Radius Proxy. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "rawDataTotalCount": 4,
  "totalCount": 4,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "ae72f54a-d1af-49b3-a310-a9bb6a3037a8_127.0.0.1_00:0C:29:FD:E2:4C",
      "aaASerIp": "127.0.0.1",
      "nasType": 1,
      "numSuccAuth": 0,
      "numFailAuth": 0,
      "numInCompAuth": 0,
      "numSuccAcct": 0,
      "numFailAcct": 0,
      "numOfAccReqAaa": 0,
      "numOfAccAcceptAaa": 0,
      "numOfAccRejAaa": 0,
      "numOfAccChallAaa": 0,
      "numOfAcctReqAaa": 0,
      "numOfAcctRspAaa": 0,
      "numOfCoAReqAaa": 0,
      "numOfCoAResAaa": 0,
      "numOfCoAFailAaa": 2,
      "numAcsRqRcvdNas": 0,
      "numAcsChSntNas": 0,
      "numAcsAcpSntNas": 0,
      "numAcsRejSntNas": 0,
      "numAccRqRcvdNas": 0,
      "numAccRspSntNas": 0,
      "numCoaSntNas": 0,
      "numCoaSucRcdNas": 0,
      "numCoaFailRcdNas": 0,
      "numDmSntNas": 0,
      "numDmSucRcdNas": 0,
      "numDmFailRcdNas": 0,
      "numAuthOnlyAAA": 0,
      "numAuthOnlySuccAAA": 0,
      "numAuthOnlyFailedAAA": 0,
      "recCreateTime": 1567761518000,
      "recUpdateTime": 1568097959000,
      "cbladeId": "00:0C:29:FD:E2:4C",
      "aaaServiceName": "",
      "mvnoId": "ae72f54a-d1af-49b3-a310-a9bb6a3037a8",
      "numOfDmReqAaa": 0,
      "numOfDmResAaa": 0,
      "numOfDmFailAaa": 0,
      "numRadSuccAPAcc": 0,
      "numRadFailAPAcc": 0,
      "numAPAcctReq": 0,
      "numAPAcctRsp": 0,
      "numDroppedRateLimitAuth": 0,
      "numDroppedRateLimitAcct": 0,
      "mvnoName": "MVNO",
      "cbladeName": "00:0C:29:FD:E2:4C"
    },
    {
      "id": "839f87c6-d116-497e-afce-aa8157abd30c_10.174.88.166_00:0C:29:FD:E2:4C",
      "aaASerIp": "10.174.88.166",
      "nasType": 1,
      "numSuccAuth": 66,
      "numFailAuth": 1,
      "numInCompAuth": 0,
      "numSuccAcct": 57,
      "numFailAcct": 0,
      "numOfAccReqAaa": 728,
      "numOfAccAcceptAaa": 65,
      "numOfAccRejAaa": 1,
      "numOfAccChallAaa": 536,
      "numOfAcctReqAaa": 830,
      "numOfAcctRspAaa": 830,
      "numOfCoAReqAaa": 0,
      "numOfCoAResAaa": 0,
      "numOfCoAFailAaa": 0,
      "numAcsRqRcvdNas": 728,
      "numAcsChSntNas": 536,
      "numAcsAcpSntNas": 0,
      "numAcsRejSntNas": 1,
      "numAccRqRcvdNas": 830,
      "numAccRspSntNas": 830,
      "numCoaSntNas": 0,
      "numCoaSucRcdNas": 0,
      "numCoaFailRcdNas": 0,
      "numDmSntNas": 0,
      "numDmSucRcdNas": 0,
      "numDmFailRcdNas": 0,
      "numAuthOnlyAAA": 0,
      "numAuthOnlySuccAAA": 0,
      "numAuthOnlyFailedAAA": 0,
      "recCreateTime": 1568194505000,
      "recUpdateTime": 1568627976000,
      "cbladeId": "00:0C:29:FD:E2:4C",
      "aaaServiceName": "",
      "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "numOfDmReqAaa": 0,
      "numOfDmResAaa": 0,
      "numOfDmFailAaa": 0,
      "numRadSuccAPAcc": 57,
      "numRadFailAPAcc": 0,
      "numAPAcctReq": 830,
      "numAPAcctRsp": 830,
      "numDroppedRateLimitAuth": 0,
      "numDroppedRateLimitAcct": 0,
      "mvnoName": "Super",
      "cbladeName": "00:0C:29:FD:E2:4C"
    },
    {
      "id": "839f87c6-d116-497e-afce-aa8157abd30c_10.174.88.97_00:0C:29:FD:E2:4C",
      "aaASerIp": "10.174.88.97",
      "nasType": 1,
      "numSuccAuth": 2,
      "numFailAuth": 0,
      "numInCompAuth": 0,
      "numSuccAcct": 2,
      "numFailAcct": 0,
      "numOfAccReqAaa": 8,
      "numOfAccAcceptAaa": 2,
      "numOfAccRejAaa": 0,
      "numOfAccChallAaa": 6,
      "numOfAcctReqAaa": 5,
      "numOfAcctRspAaa": 5,
      "numOfCoAReqAaa": 0,
      "numOfCoAResAaa": 0,
      "numOfCoAFailAaa": 0,
      "numAcsRqRcvdNas": 8,
      "numAcsChSntNas": 6,
      "numAcsAcpSntNas": 0,
      "numAcsRejSntNas": 0,
      "numAccRqRcvdNas": 5,
      "numAccRspSntNas": 5,
      "numCoaSntNas": 0,
      "numCoaSucRcdNas": 0,
      "numCoaFailRcdNas": 0,
      "numDmSntNas": 0,
      "numDmSucRcdNas": 0,
      "numDmFailRcdNas": 0,
      "numAuthOnlyAAA": 0,
      "numAuthOnlySuccAAA": 0,
      "numAuthOnlyFailedAAA": 0,
      "recCreateTime": 1566543372000,
      "recUpdateTime": 1567495289000,
      "cbladeId": "00:0C:29:FD:E2:4C",
      "aaaServiceName": "",
      "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "numOfDmReqAaa": 0,
      "numOfDmResAaa": 0,
      "numOfDmFailAaa": 0,
      "numRadSuccAPAcc": 0,
      "numRadFailAPAcc": 0,
      "numAPAcctReq": 0,
      "numAPAcctRsp": 0,
      "numDroppedRateLimitAuth": 0,
      "numDroppedRateLimitAcct": 0,
      "mvnoName": "Super",
      "cbladeName": "00:0C:29:FD:E2:4C"
    },
    {
      "id": "ae72f54a-d1af-49b3-a310-a9bb6a3037a8_10.174.88.97_00:0C:29:FD:E2:4C",
      "aaASerIp": "10.174.88.97",
      "nasType": 1,
      "numSuccAuth": 13,
      "numFailAuth": 0,
      "numInCompAuth": 0,
      "numSuccAcct": 7,
      "numFailAcct": 0,
      "numOfAccReqAaa": 169,
      "numOfAccAcceptAaa": 13,
      "numOfAccRejAaa": 0,
      "numOfAccChallAaa": 39,
      "numOfAcctReqAaa": 2315,
      "numOfAcctRspAaa": 2315,
      "numOfCoAReqAaa": 4,
      "numOfCoAResAaa": 0,
      "numOfCoAFailAaa": 2,
      "numAcsRqRcvdNas": 169,
      "numAcsChSntNas": 39,
      "numAcsAcpSntNas": 0,
      "numAcsRejSntNas": 0,
      "numAccRqRcvdNas": 2315,
      "numAccRspSntNas": 2315,
      "numCoaSntNas": 0,
      "numCoaSucRcdNas": 0,
      "numCoaFailRcdNas": 0,
      "numDmSntNas": 0,
      "numDmSucRcdNas": 0,
      "numDmFailRcdNas": 0,
      "numAuthOnlyAAA": 0,
      "numAuthOnlySuccAAA": 0,
      "numAuthOnlyFailedAAA": 0,
      "recCreateTime": 1568098785000,
      "recUpdateTime": 1568627976000,
      "cbladeId": "00:0C:29:FD:E2:4C",
      "aaaServiceName": "",
      "mvnoId": "ae72f54a-d1af-49b3-a310-a9bb6a3037a8",
      "numOfDmReqAaa": 0,
      "numOfDmResAaa": 0,
      "numOfDmFailAaa": 0,
      "numRadSuccAPAcc": 0,
      "numRadFailAPAcc": 0,
      "numAPAcctReq": 0,
      "numAPAcctRsp": 0,
      "numDroppedRateLimitAuth": 0,
      "numDroppedRateLimitAcct": 0,
      "mvnoName": "MVNO",
      "cbladeName": "00:0C:29:FD:E2:4C"
    }
  ],
  "extra": null
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "totalCount": {
      "type": "integer"
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "aaASerIp": {
            "type": "string",
            "description": "AAA IP"
          },
          "nasType": {
            "description": "NAS Type. 1: Ruckus AP 2: 3rd Party AP",
            "type": "integer",
            "format": "int64"
          },
          "numSuccAuth": {
            "description": "Number of authentications (Successful)",
            "type": "integer",
            "format": "int64"
          },
          "numFailAuth": {
            "description": "Number of authentications (Failed)",
            "type": "integer",
            "format": "int64"
          },
          "numInCompAuth": {
            "description": "Number of authentications (Incomplete)",
            "type": "integer",
            "format": "int64"
          },
          "numSuccAcct": {
            "description": "Number of accounting sessions established (Successful)",
            "type": "integer",
            "format": "int64"
          },
          "numFailAcct": {
            "description": "Number of accounting sessions established (Failed)",
            "type": "integer",
            "format": "int64"
          },
          "numOfAccReqAaa": {
            "description": "Number of RADIUS access requests sent to AAA server",
            "type": "integer",
            "format": "int64"
          },
          "numOfAccAcceptAaa": {
            "description": "Number of RADIUS access accepts received from AAA server",
            "type": "integer",
            "format": "int64"
          },
          "numOfAccRejAaa": {
            "description": "Number of RADIUS access rejects received from AAA server",
            "type": "integer",
            "format": "int64"
          },
          "numOfAccChallAaa": {
            "description": "Number of RADIUS access challenges received from AAA server",
            "type": "integer",
            "format": "int64"
          },
          "numOfAcctReqAaa": {
            "description": "Number of RADIUS accounting requests sent to AAA server",
            "type": "integer",
            "format": "int64"
          },
          "numOfAcctRspAaa": {
            "description": "Number of RADIUS accounting responses received from AAA server",
            "type": "integer",
            "format": "int64"
          },
          "numOfCoAReqAaa": {
            "description": "Number of RADIUS CoA requests received from AAA server",
            "type": "integer",
            "format": "int64"
          },
          "numOfCoAResAaa": {
            "description": "Number of RADIUS CoA responses sent to AAA server (Successful)",
            "type": "integer",
            "format": "int64"
          },
          "numOfCoAFailAaa": {
            "description": "Number of RADIUS CoA responses sent to AAA server (Failed)",
            "type": "integer",
            "format": "int64"
          },
          "numAcsRqRcvdNas": {
            "description": "Number of RADIUS access requests received from NAS",
            "type": "integer",
            "format": "int64"
          },
          "numAcsChSntNas": {
            "description": "Number of RADIUS access challenges sent to NAS",
            "type": "integer",
            "format": "int64"
          },
          "numAcsAcpSntNas": {
            "description": "Number of RADIUS access accepts sent to NAS",
            "type": "integer",
            "format": "int64"
          },
          "numAcsRejSntNas": {
            "description": "Number of RADIUS access rejects sent to the NAS",
            "type": "integer",
            "format": "int64"
          },
          "numAccRqRcvdNas": {
            "description": "Number of RADIUS accounting requests received from NAS",
            "type": "integer",
            "format": "int64"
          },
          "numAccRspSntNas": {
            "description": "Number of RADIUS accounting responses sent to NAS",
            "type": "integer",
            "format": "int64"
          },
          "numCoaSntNas": {
            "description": "Number of CoA sent to NAS",
            "type": "integer",
            "format": "int64"
          },
          "numCoaSucRcdNas": {
            "description": "Number of successful CoA responses from NAS",
            "type": "integer",
            "format": "int64"
          },
          "numCoaFailRcdNas": {
            "description": "Number of Failed CoA response from NAS",
            "type": "integer",
            "format": "int64"
          },
          "numDmSntNas": {
            "description": "Number of RADIUS DM requests sent to NAS",
            "type": "integer",
            "format": "int64"
          },
          "numDmSucRcdNas": {
            "description": "Number of RADIUS DM responses received from NAS (Successful)",
            "type": "integer",
            "format": "int64"
          },
          "numDmFailRcdNas": {
            "description": "Number of RADIUS DM responses received from NAS (Failed)",
            "type": "integer",
            "format": "int64"
          },
          "numAuthOnlyAAA": {
            "description": "Number of CoA authorize only processed",
            "type": "integer",
            "format": "int64"
          },
          "numAuthOnlySuccAAA": {
            "description": "Number of successful CoA authorize only procedures",
            "type": "integer",
            "format": "int64"
          },
          "numAuthOnlyFailedAAA": {
            "description": "Number of failed CoA authorize only procedures",
            "type": "integer",
            "format": "int64"
          },
          "recCreateTime": {
            "description": "Time this entry was created",
            "type": "integer",
            "format": "int64"
          },
          "recUpdateTime": {
            "description": "Last time this entry was updated",
            "type": "integer",
            "format": "int64"
          },
          "cbladeId": {
            "type": "string",
            "description": "Control Balde ID"
          },
          "aaaServiceName": {
            "type": "string",
            "description": "AAA Service Name"
          },
          "mvnoId": {
            "type": "string",
            "description": "MVNO ID"
          },
          "numOfDmReqAaa": {
            "description": "Number of RADIUS DM responses sent to AAA server (Successful)",
            "type": "integer",
            "format": "int64"
          },
          "numOfDmResAaa": {
            "description": "Number of RADIUS DM requests received from AAA server",
            "type": "integer",
            "format": "int64"
          },
          "numOfDmFailAaa": {
            "description": "Number of RADIUS DM responses sent to AAA server (Failed)",
            "type": "integer",
            "format": "int64"
          },
          "numRadSuccAPAcc": {
            "description": "Number of AP accounting sessions established (Successful)",
            "type": "integer",
            "format": "int64"
          },
          "numRadFailAPAcc": {
            "description": "Number of AP accounting sessions established (Failed)",
            "type": "integer",
            "format": "int64"
          },
          "numAPAcctReq": {
            "description": "Number of AP accounting requests",
            "type": "integer",
            "format": "int64"
          },
          "numAPAcctRsp": {
            "description": "Number of AP accounting responses",
            "type": "integer",
            "format": "int64"
          },
          "numDroppedRateLimitAuth": {
            "description": "Number of dropped authentication requests",
            "type": "integer",
            "format": "int64"
          },
          "numDroppedRateLimitAcct": {
            "description": "Number of dropped accounting requests",
            "type": "integer",
            "format": "int64"
          },
          "cbladeName": {
            "type": "string",
            "description": "Control Balde Name"
          },
          "mvnoName": {
            "type": "string",
            "description": "MVNO Name"
          }
        }
      }
    }
  }
}

Event and Alarm

Retrieve Alarm List

POST/v11_1/alert/alarm/list

Query Alarms with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    },
    {
      "type": "CATEGORY",
      "value": "Cluster"
    },
    {
      "type": "CATEGORY",
      "value": "Control_Plane"
    },
    {
      "type": "CATEGORY",
      "value": "Data_Plane"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "insertionTime",
    "dir": "DESC"
  },
  "page": 1,
  "limit": 10
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "rawDataTotalCount": 3,
  "totalCount": 3,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "Alarm_951_00:0C:29:93:00:00",
      "insertionTime": 1487670600858,
      "alarmType": "Memory threshold exceeded",
      "alarmCode": 951,
      "alarmState": "Cleared",
      "severity": "Critical",
      "activity": "Memory threshold [95.15%] exceeded on control plane [ui206-C].",
      "acknowledged": "No",
      "ackTime": null,
      "ackUser": null,
      "category": "Control_Plane",
      "clearComment": "Auto Cleared",
      "clearTime": 1487671200984,
      "clearUser": "System"
    },
    {
      "id": "Alarm_303_94:F6:65:3C:93:C0",
      "insertionTime": 1487666250201,
      "alarmType": "AP disconnected",
      "alarmCode": 303,
      "alarmState": "Cleared",
      "severity": "Major",
      "activity": "AP [RuckusAP@94:F6:65:3C:93:C0] disconnected.",
      "acknowledged": "Yes",
      "ackTime": 1487735042472,
      "ackUser": "admin",
      "category": "AP",
      "clearComment": "test bulk clear",
      "clearTime": 1487735127383,
      "clearUser": "admin"
    },
    {
      "id": "AVpG_G6RyxBWfBW4KnsQ",
      "insertionTime": 1487249632908,
      "alarmType": "AP rebooted by system",
      "alarmCode": 302,
      "alarmState": "Cleared",
      "severity": "Major",
      "activity": "AP [RuckusAP@94:F6:65:3C:93:C0] rebooted by the system because of [application, wsgclient, reboot due to firmware change ].",
      "acknowledged": "Yes",
      "ackTime": 1487735042514,
      "ackUser": "admin",
      "category": "AP",
      "clearComment": "test bulk clear",
      "clearTime": 1487735127377,
      "clearUser": "admin"
    }
  ],
  "extra": null
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "totalCount": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "ackTime": {
            "type": "integer",
            "format": "int64"
          },
          "ackUser": {
            "type": "string"
          },
          "acknowledged": {
            "type": "string"
          },
          "activity": {
            "type": "string"
          },
          "alarmCode": {
            "type": "integer"
          },
          "alarmState": {
            "type": "string"
          },
          "alarmType": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "clearComment": {
            "type": "string"
          },
          "clearTime": {
            "type": "integer",
            "format": "int64"
          },
          "clearUser": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "insertionTime": {
            "type": "integer",
            "format": "int64"
          },
          "severity": {
            "type": "string"
          }
        }
      }
    },
    "rawDataTotalCount": {
      "type": "integer"
    }
  }
}

Retrieve Event Summary

POST/v11_1/alert/eventSummary

Use this API command to retrieve the event summary with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "criticalCount": 4,
  "majorCount": 2,
  "minorCount": 5,
  "warningCount": 5,
  "informationalCount": 2,
  "debugCount": 5
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "criticalCount": {
      "type": "integer",
      "format": "int64"
    },
    "majorCount": {
      "type": "integer",
      "format": "int64"
    },
    "minorCount": {
      "type": "integer",
      "format": "int64"
    },
    "warningCount": {
      "type": "integer",
      "format": "int64"
    },
    "informationalCount": {
      "type": "integer",
      "format": "int64"
    },
    "debugCount": {
      "type": "integer",
      "format": "int64"
    }
  }
}

Retrieve Alarm Summary

POST/v11_1/alert/alarmSummary

Use this API command to retrieve the alarm summary with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "criticalCount": 3,
  "majorCount": 3,
  "minorCount": 4,
  "warningCount": 0
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "criticalCount": {
      "type": "integer",
      "format": "int64"
    },
    "majorCount": {
      "type": "integer",
      "format": "int64"
    },
    "minorCount": {
      "type": "integer",
      "format": "int64"
    },
    "warningCount": {
      "type": "integer",
      "format": "int64"
    }
  }
}

Retrieve Event List

POST/v11_1/alert/event/list

Query Events with specified filters. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    },
    {
      "type": "CATEGORY",
      "value": "Cluster"
    },
    {
      "type": "CATEGORY",
      "value": "Control_Plane"
    },
    {
      "type": "CATEGORY",
      "value": "Data_Plane"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "insertionTime",
    "dir": "DESC"
  },
  "page": 7,
  "limit": 10
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "rawDataTotalCount": 287,
  "totalCount": 287,
  "hasMore": true,
  "firstIndex": 70,
  "list": [
    {
      "id": "AVpeTrTUyxBWfBW4Kn0G",
      "insertionTime": 1487640900817,
      "eventType": "Memory threshold exceeded",
      "eventCode": 951,
      "severity": "Critical",
      "activity": "Memory threshold [89.73%] exceeded on control plane [ui206-C].",
      "category": "Control_Plane"
    },
    {
      "id": "AVpeNCpZyxBWfBW4Kn0F",
      "insertionTime": 1487639161431,
      "eventType": "AP health high airtime utilization clear",
      "eventCode": 348,
      "severity": "Informational",
      "activity": "AP [RuckusAP@94:F6:65:3C:93:C0] cleared 2.4GHz} airtime utilization health [24], which is no longer past the threshold [70].",
      "category": "AP"
    },
    {
      "id": "AVpeLMFFyxBWfBW4Kn0E",
      "insertionTime": 1487638675779,
      "eventType": "AP channel updated",
      "eventCode": 306,
      "severity": "Informational",
      "activity": "AP [RuckusAP@94:F6:65:3C:93:C0] detected interference on radio [11a/n] and has switched from channel [157] to channel [149].",
      "category": "AP"
    },
    {
      "id": "AVpeLMDHyxBWfBW4Kn0D",
      "insertionTime": 1487638675652,
      "eventType": "AP channel updated",
      "eventCode": 306,
      "severity": "Informational",
      "activity": "AP [RuckusAP@94:F6:65:3C:93:C0] detected interference on radio [11g/n] and has switched from channel [6] to channel [8].",
      "category": "AP"
    },
    {
      "id": "AVpeFfOZyxBWfBW4Kn0C",
      "insertionTime": 1487637181335,
      "eventType": "AP health high airtime utilization flag",
      "eventCode": 347,
      "severity": "Warning",
      "activity": "AP [RuckusAP@94:F6:65:3C:93:C0] flagged 2.4GHz} airtime utilization health [79] because it crossed the threshold [70].",
      "category": "AP"
    },
    {
      "id": "AVpeEUcsyxBWfBW4Kn0B",
      "insertionTime": 1487636875050,
      "eventType": "AP channel updated",
      "eventCode": 306,
      "severity": "Informational",
      "activity": "AP [RuckusAP@94:F6:65:3C:93:C0] detected interference on radio [11a/n] and has switched from channel [149] to channel [157].",
      "category": "AP"
    },
    {
      "id": "AVpeCB5wyxBWfBW4Kn0A",
      "insertionTime": 1487636274798,
      "eventType": "AP channel updated",
      "eventCode": 306,
      "severity": "Informational",
      "activity": "AP [RuckusAP@94:F6:65:3C:93:C0] detected interference on radio [11g/n] and has switched from channel [8] to channel [6].",
      "category": "AP"
    },
    {
      "id": "AVpd-UR7yxBWfBW4Knz_",
      "insertionTime": 1487635301493,
      "eventType": "Cluster application started",
      "eventCode": 817,
      "severity": "Informational",
      "activity": "Application [Scheduler] on node [ui206] started.",
      "category": "Cluster"
    },
    {
      "id": "AVpd9c3XyxBWfBW4Knz-",
      "insertionTime": 1487635074516,
      "eventType": "AP channel updated",
      "eventCode": 306,
      "severity": "Informational",
      "activity": "AP [RuckusAP@94:F6:65:3C:93:C0] detected interference on radio [11a/n] and has switched from channel [157] to channel [149].",
      "category": "AP"
    },
    {
      "id": "AVpdzoqwyxBWfBW4Knz9",
      "insertionTime": 1487632501419,
      "eventType": "AP health high airtime utilization clear",
      "eventCode": 348,
      "severity": "Informational",
      "activity": "AP [RuckusAP@94:F6:65:3C:93:C0] cleared 2.4GHz} airtime utilization health [62], which is no longer past the threshold [70].",
      "category": "AP"
    }
  ],
  "extra": null
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "totalCount": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "activity": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "eventCode": {
            "type": "integer"
          },
          "eventType": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "insertionTime": {
            "type": "integer",
            "format": "int64"
          },
          "severity": {
            "type": "string"
          }
        }
      }
    },
    "rawDataTotalCount": {
      "type": "integer"
    }
  }
}

Acknowledge Alarms

PUT/v11_1/alert/alarm/ack

Acknowledge multiple Alarms with provided alarmIDs.

Request
HideShow
Body
{
  "idList": [
    "Alarm_303_AB:CD:00:00:00:17",
    "Alarm_303_AB:CD:00:00:00:21"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Clear Alarms

PUT/v11_1/alert/alarm/clear

Clear multiple Alarms with provided alarmIDs.

Request
HideShow
Body
{
  "idList": [
    "Alarm_303_AB:CD:00:00:00:17",
    "Alarm_303_AB:CD:00:00:00:21"
  ],
  "comment": ""
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "comment": {
      "description": "Comment for clearing alarm",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    }
  }
}
Response  204

Acknowledge Alarm

PUT/v11_1/alert/alarm/{alarmID}/ack

Acknowledge a single Alarm with provided alarmID.

Response  200

Clear Alarm

PUT/v11_1/alert/alarm/{alarmID}/clear

Clear a single Alarm with provided alarmID.

Response  200

Switch Event Management Setting

Get Domain Switch Event E-mail Setting

GET/v11_1/domains/{domainId}/eventEmailSettings

Get Switch Event E-mail Setting of Domain Override.

Response  200
HideShow
Body
{
  "emailEnabled": true,
  "mailTo": "[email protected]"
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "emailEnabled": {
      "description": "Enable/Disable Email sending function",
      "type": "boolean"
    },
    "mailTo": {
      "description": "E-mail recipients",
      "type": "string"
    }
  }
}

Get Domain Switch Event Notification Setting

GET/v11_1/domains/{domainId}/eventNotificationSettings

Get Switch Event Notification Setting of Domain Override.

Response  200
HideShow
Body
{
  "success": true,
  "error": null,
  "data": {
    "totalCount": 2,
    "rawDataTotalCount": 0,
    "hasMore": false,
    "list": [
      {
        "eventCode": 101,
        "mainCatagory": "AP Communication",
        "category": "AP Communication",
        "type": "AP discovery succeeded",
        "severity": "Informational",
        "configPageDesc": "This event occurs when AP sends a discovery request to the Virtual SmartZone successfully.",
        "triggerTrap": false,
        "triggerEmail": true,
        "dbPersistence": false,
        "oid": "1.3.6.1.4.1.25053.2.10.1.46",
        "zoneOverride": true,
        "domainOverride": false
      },
      {
        "eventCode": 8004,
        "mainCatagory": "Client",
        "category": "Client",
        "type": "URL Filtering server reachable",
        "severity": "Major",
        "configPageDesc": "This event occurs when URL Filtering server is reachable.",
        "triggerTrap": false,
        "triggerEmail": false,
        "dbPersistence": true,
        "oid": "1.3.6.1.4.1.25053.2.10.1.100",
        "zoneOverride": false,
        "domainOverride": false
      }
    ]
  },
  "extra": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "success": {
      "description": "The status of http request",
      "type": "boolean"
    },
    "error": {
      "description": "The error message of http request",
      "type": "string"
    },
    "data": {
      "additionalProperties": false,
      "type": "object",
      "properties": {
        "totalCount": {
          "type": "integer"
        },
        "hasMore": {
          "type": "boolean"
        },
        "rawDataTotalCount": {
          "type": "integer"
        },
        "list": {
          "type": "array",
          "items": {
            "additionalProperties": false,
            "type": "object",
            "properties": {
              "eventCode": {
                "description": "Event code",
                "type": "integer"
              },
              "severity": {
                "description": "Event severity",
                "type": "string"
              },
              "category": {
                "description": "Event category",
                "type": "string"
              },
              "type": {
                "description": "Event type",
                "type": "string"
              },
              "triggerEmail": {
                "description": "Enable/Disable Email sending for this event",
                "type": "boolean"
              },
              "triggerTrap": {
                "description": "Enable/Disable SNMP function for this event",
                "type": "boolean"
              },
              "dbPersistence": {
                "description": "Enable/Disable DB persistence for this event",
                "type": "boolean"
              },
              "zoneOverride": {
                "description": "Enable/Disable override event system settings by zone level",
                "type": "boolean"
              },
              "domainOverride": {
                "description": "Enable/Disable override event system settings by domain level",
                "type": "boolean"
              },
              "oid": {
                "description": "Event OID",
                "type": "string"
              },
              "configPageDesc": {
                "description": "Event description",
                "type": "string"
              }
            }
          }
        }
      }
    },
    "extra": {
      "description": "Extra information for event management setting",
      "type": "string"
    }
  }
}

Modify Domain Switch Event E-mail Setting

PUT/v11_1/domains/{domainId}/eventEmailSettings

Modify Switch Event E-mail Setting of Domain Override.

Request
HideShow
Body
{
  "emailEnabled": true,
  "mailTo": "[email protected]"
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "emailEnabled": {
      "description": "Enable/Disable Email sending function",
      "type": "boolean"
    },
    "mailTo": {
      "description": "E-mail recipients",
      "type": "string"
    }
  }
}
Response  204

Modify Domain Switch Event Notification Setting

PUT/v11_1/domains/{domainId}/eventNotificationSettings

Modify Switch Event Notification Setting of Domain Override.

Request
HideShow
Body
[
  {
    "eventCode": 101,
    "triggerEmail": true,
    "triggerTrap": false,
    "dbPersistence": false,
    "zoneOverride": true,
    "domainOverride": false
  },
  {
    "eventCode": 202,
    "triggerEmail": true,
    "triggerTrap": false,
    "dbPersistence": false,
    "zoneOverride": true,
    "domainOverride": false
  }
]
Schema
{
  "additionalProperties": false,
  "type": "array",
  "items": {
    "additionalProperties": false,
    "type": "object",
    "properties": {
      "eventCode": {
        "description": "Event code",
        "type": "integer"
      },
      "severity": {
        "description": "Event severity",
        "type": "string"
      },
      "category": {
        "description": "Event category",
        "type": "string"
      },
      "type": {
        "description": "Event type",
        "type": "string"
      },
      "triggerEmail": {
        "description": "Enable/Disable Email sending for this event",
        "type": "boolean"
      },
      "triggerTrap": {
        "description": "Enable/Disable SNMP function for this event",
        "type": "boolean"
      },
      "dbPersistence": {
        "description": "Enable/Disable DB persistence for this event",
        "type": "boolean"
      },
      "zoneOverride": {
        "description": "Enable/Disable override event system settings by zone level",
        "type": "boolean"
      },
      "domainOverride": {
        "description": "Enable/Disable override event system settings by domain level",
        "type": "boolean"
      },
      "oid": {
        "description": "Event OID",
        "type": "string"
      },
      "configPageDesc": {
        "description": "Event description",
        "type": "string"
      }
    }
  }
}
Response  204

Event Management Setting

Get Event E-mail Setting

GET/v11_1/rkszones/{zoneId}/eventEmailSettings

Get Event E-mail Setting of Zone Override.

Response  200
HideShow
Body
{
  "emailEnabled": true,
  "mailTo": "[email protected]"
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "emailEnabled": {
      "description": "Enable/Disable Email sending function",
      "type": "boolean"
    },
    "mailTo": {
      "description": "E-mail recipients",
      "type": "string"
    }
  }
}

Get Event Notification Setting

GET/v11_1/rkszones/{zoneId}/eventNotificationSettings

Get Event Notification Setting of Zone Override.

Response  200
HideShow
Body
{
  "success": true,
  "error": null,
  "data": {
    "totalCount": 2,
    "rawDataTotalCount": 0,
    "hasMore": false,
    "list": [
      {
        "eventCode": 101,
        "mainCatagory": "AP Communication",
        "category": "AP Communication",
        "type": "AP discovery succeeded",
        "severity": "Informational",
        "configPageDesc": "This event occurs when AP sends a discovery request to the Virtual SmartZone successfully.",
        "triggerTrap": false,
        "triggerEmail": true,
        "dbPersistence": false,
        "oid": "1.3.6.1.4.1.25053.2.10.1.46",
        "zoneOverride": true,
        "domainOverride": false
      },
      {
        "eventCode": 8004,
        "mainCatagory": "Client",
        "category": "Client",
        "type": "URL Filtering server reachable",
        "severity": "Major",
        "configPageDesc": "This event occurs when URL Filtering server is reachable.",
        "triggerTrap": false,
        "triggerEmail": false,
        "dbPersistence": true,
        "oid": "1.3.6.1.4.1.25053.2.10.1.100",
        "zoneOverride": false,
        "domainOverride": false
      }
    ]
  },
  "extra": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "success": {
      "description": "The status of http request",
      "type": "boolean"
    },
    "error": {
      "description": "The error message of http request",
      "type": "string"
    },
    "data": {
      "additionalProperties": false,
      "type": "object",
      "properties": {
        "totalCount": {
          "type": "integer"
        },
        "hasMore": {
          "type": "boolean"
        },
        "rawDataTotalCount": {
          "type": "integer"
        },
        "list": {
          "type": "array",
          "items": {
            "additionalProperties": false,
            "type": "object",
            "properties": {
              "eventCode": {
                "description": "Event code",
                "type": "integer"
              },
              "severity": {
                "description": "Event severity",
                "type": "string"
              },
              "category": {
                "description": "Event category",
                "type": "string"
              },
              "type": {
                "description": "Event type",
                "type": "string"
              },
              "triggerEmail": {
                "description": "Enable/Disable Email sending for this event",
                "type": "boolean"
              },
              "triggerTrap": {
                "description": "Enable/Disable SNMP function for this event",
                "type": "boolean"
              },
              "dbPersistence": {
                "description": "Enable/Disable DB persistence for this event",
                "type": "boolean"
              },
              "zoneOverride": {
                "description": "Enable/Disable override event system settings by zone level",
                "type": "boolean"
              },
              "domainOverride": {
                "description": "Enable/Disable override event system settings by domain level",
                "type": "boolean"
              },
              "oid": {
                "description": "Event OID",
                "type": "string"
              },
              "configPageDesc": {
                "description": "Event description",
                "type": "string"
              }
            }
          }
        }
      }
    },
    "extra": {
      "description": "Extra information for event management setting",
      "type": "string"
    }
  }
}

Modify Event E-mail Setting

PUT/v11_1/rkszones/{zoneId}/eventEmailSettings

Modify Event E-mail Setting of Zone Override.

Request
HideShow
Body
{
  "emailEnabled": true,
  "mailTo": "[email protected]"
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "emailEnabled": {
      "description": "Enable/Disable Email sending function",
      "type": "boolean"
    },
    "mailTo": {
      "description": "E-mail recipients",
      "type": "string"
    }
  }
}
Response  204

Modify Event Notification Setting

PUT/v11_1/rkszones/{zoneId}/eventNotificationSettings

Modify Event Notification Setting of Zone Override.

Request
HideShow
Body
[
  {
    "eventCode": 101,
    "triggerEmail": true,
    "triggerTrap": false,
    "dbPersistence": false,
    "zoneOverride": true,
    "domainOverride": false
  },
  {
    "eventCode": 202,
    "triggerEmail": true,
    "triggerTrap": false,
    "dbPersistence": false,
    "zoneOverride": true,
    "domainOverride": false
  }
]
Schema
{
  "additionalProperties": false,
  "type": "array",
  "items": {
    "additionalProperties": false,
    "type": "object",
    "properties": {
      "eventCode": {
        "description": "Event code",
        "type": "integer"
      },
      "severity": {
        "description": "Event severity",
        "type": "string"
      },
      "category": {
        "description": "Event category",
        "type": "string"
      },
      "type": {
        "description": "Event type",
        "type": "string"
      },
      "triggerEmail": {
        "description": "Enable/Disable Email sending for this event",
        "type": "boolean"
      },
      "triggerTrap": {
        "description": "Enable/Disable SNMP function for this event",
        "type": "boolean"
      },
      "dbPersistence": {
        "description": "Enable/Disable DB persistence for this event",
        "type": "boolean"
      },
      "zoneOverride": {
        "description": "Enable/Disable override event system settings by zone level",
        "type": "boolean"
      },
      "domainOverride": {
        "description": "Enable/Disable override event system settings by domain level",
        "type": "boolean"
      },
      "oid": {
        "description": "Event OID",
        "type": "string"
      },
      "configPageDesc": {
        "description": "Event description",
        "type": "string"
      }
    }
  }
}
Response  204

Cluster Management

Retrieve List

GET/v11_1/configuration

Retrive system configuration list.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "b9c6e66e-f436-402f-a8b1-004d0b9ec7d8",
      "createdOn": "2015/04/29 16:27:13",
      "scgVersion": "3.2.0.0.71",
      "controlPlaneSoftwareVersion": "3.2.0.0.56",
      "dataPlaneSoftwareVersion": "0.0.0.0",
      "createdBy": "admin",
      "type": "1",
      "backupElapsed": null,
      "fileSize": 40026
    },
    {
      "id": "b0d4df4d-c8eb-4738-ae45-ce73bf936f34",
      "createdOn": "2015/04/29 16:48:32",
      "scgVersion": "3.2.0.0.71",
      "controlPlaneSoftwareVersion": "3.2.0.0.56",
      "dataPlaneSoftwareVersion": "0.0.0.0",
      "createdBy": "admin",
      "type": "1",
      "backupElapsed": null,
      "fileSize": 40053
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of system configuration backup file.",
            "type": "string"
          },
          "createdOn": {
            "description": "the create time of the configuration backup file.",
            "type": "number"
          },
          "scgVersion": {
            "description": "SCG version of the configuration backup file.",
            "type": "string"
          },
          "controlPlaneSoftwareVersion": {
            "description": "control plane software version of the configuration backup file",
            "type": "string"
          },
          "dataPlaneSoftwareVersion": {
            "description": "data plane software version of the configuration backup file",
            "type": "string"
          },
          "createdBy": {
            "description": "creator of the configuration backup file.",
            "type": "string"
          },
          "type": {
            "description": "type of the configuration backup file",
            "type": "string"
          },
          "backupElapsed": {
            "description": "backup elapsed of the configuration backup file",
            "type": "integer",
            "format": "int64"
          },
          "fileSize": {
            "description": "file size of the backup file",
            "type": "integer",
            "format": "int64"
          },
          "md5": {
            "description": "file md5 of the backup file",
            "type": "string"
          }
        }
      }
    }
  }
}

Get Auto Export Backup

GET/v11_1/configurationSettings/autoExportBackup

Get Auto Export Backup Settings.

Response  200
HideShow
Body
{
  "enableAutoExportBackup": true,
  "ftpNamePrefix": "File prefix name",
  "ftpServer": "FTP server name"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enableAutoExportBackup": {
      "description": "enable auto export backup",
      "type": "boolean"
    },
    "ftpNamePrefix": {
      "description": "File prefix name",
      "type": "string"
    },
    "ftpServer": {
      "description": "FTP server name",
      "type": "string"
    }
  }
}

Get Schedule Backup Setting

GET/v11_1/configurationSettings/scheduleBackup

Get Schedule Backup Setting.

Response  200
HideShow
Body
{
  "enableScheduleBackup": true,
  "interval": "MONTHLY",
  "dateOfMonth": 5,
  "hour": 2,
  "minute": 15
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enableScheduleBackup": {
      "description": "enable schedule backup",
      "type": "boolean"
    },
    "interval": {
      "description": "schedule interval",
      "type": "string",
      "enum": [
        "MONTHLY",
        "WEEKLY",
        "DAILY"
      ]
    },
    "dayOfWeek": {
      "description": "day of the week",
      "type": "string",
      "enum": [
        "SUNDAY",
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY",
        "SATURDAY"
      ]
    },
    "dateOfMonth": {
      "description": "date of the month",
      "type": "integer"
    },
    "hour": {
      "description": "hour",
      "type": "integer"
    },
    "minute": {
      "description": "minute",
      "type": "integer"
    }
  }
}

Download

GET/v11_1/configuration/download

Download system configuration file.

URI Parameters
HideShow
backupUUID
string (required) 

System configuration file uuid

timeZone
string (optional) 

DEPRECATED Time zone

Response  200
HideShow
Headers
Content-Type: application/octet-stream

Retrieve List

GET/v11_1/cluster

Retrive cluster backup list.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

timezone
string (optional) 

Change display timezone of created date and time, like timezone=Asia/Taipei, default is UTC time.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "20150907031120_3.2.0.0.721",
      "version": "3.2.0.0.721",
      "filesize": "998.4 MB",
      "createdOn": "2015/09/07 11:11:20"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of cluster backup file.",
            "type": "string"
          },
          "version": {
            "description": "the patch version of the cluster backup file.",
            "type": "string"
          },
          "filesize": {
            "description": "filesize of the cluster backup file.",
            "type": "number"
          },
          "createdOn": {
            "description": "Created date and time of the cluster backup file",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrive Cluster Progress Status

GET/v11_1/upgrade/status

Use this API command to retrive cluster progress status.

Response  200
HideShow
Body
{
  "clusterOperationProgress": {
    "operation": "None",
    "overallProgress": 0,
    "isSelfBladeRebooting": null,
    "bladeProgresss": [
      {
        "bladeUUID": "386988fe-72fe-41e0-a373-7a73fea5d16e",
        "hostName": "neilscg200",
        "iterationName": "None",
        "state": "",
        "progress": 0
      }
    ],
    "previousOperationRecord": {
      "operation": "Upload",
      "success": true,
      "errorMsg": null
    },
    "clusterSubTaskState": "Completed",
    "clusterOperationBlockUI": false,
    "clusterOperationDisplayMsg": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "clusterOperationProgress": {
      "description": "upgrade status",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "operation": {
          "description": "operation of clusterOperationProgress",
          "type": "string",
          "enum": [
            "None",
            "Join",
            "Backup",
            "Restore",
            "Upload",
            "Upgrade",
            "BackupAndUpgrade",
            "RemoveBlade",
            "ChangeBladeIP",
            "DiskSnapshot",
            "UploadVDPFirmware",
            "UploadAPFirmware",
            "AddAPFirmware",
            "AddLteFirmware"
          ]
        },
        "overallProgress": {
          "description": "overallProgress of clusterOperationProgress",
          "type": "integer"
        },
        "previousOperationRecord": {
          "description": "previousOperationRecord of clusterOperationProgress",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "operation": {
              "description": "operation of previousOperationRecord",
              "type": "string",
              "enum": [
                "None",
                "Join",
                "Backup",
                "Restore",
                "Upload",
                "Upgrade",
                "BackupAndUpgrade",
                "RemoveBlade",
                "ChangeBladeIP",
                "DiskSnapshot",
                "UploadVDPFirmware",
                "UploadAPFirmware",
                "AddAPFirmware",
                "AddLteFirmware"
              ]
            },
            "success": {
              "description": "success of previousOperationRecord",
              "type": "boolean"
            },
            "errorMsg": {
              "description": "errorMsg of previousOperationRecord",
              "type": "string"
            }
          }
        },
        "isSelfBladeRebooting": {
          "description": "isSelfBladeRebooting of clusterOperationProgress",
          "type": "boolean"
        },
        "bladeProgresss": {
          "description": "bladeProgressMap of clusterOperationProgress",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "bladeUUID": {
                "description": "bladeUUID of bladeProgress",
                "type": "string"
              },
              "hostName": {
                "description": "hostName of bladeProgress",
                "type": "string"
              },
              "iterationName": {
                "description": "iterationName of bladeProgress",
                "type": "string"
              },
              "state": {
                "description": "state of bladeProgress",
                "type": "string"
              },
              "progress": {
                "description": "progress of bladeProgress",
                "type": "integer"
              }
            }
          }
        },
        "clusterSubTaskState": {
          "description": "clusterSubTaskState of clusterOperationProgress",
          "type": "string",
          "enum": [
            "None",
            "Running",
            "Failed",
            "Completed"
          ]
        },
        "clusterOperationBlockUI": {
          "description": "clusterOperationBlockUI of clusterOperationProgress",
          "type": "boolean"
        },
        "clusterOperationDisplayMsg": {
          "description": "clusterOperationDisplayMsg of clusterOperationProgress",
          "type": "string"
        }
      }
    }
  }
}

Retrive Upload Patch Info

GET/v11_1/upgrade/patch

Use this API command to retrive upload file Info.

Response  200
HideShow
Body
{
  "clusterOperationProgress": {
    "operation": "None",
    "overallProgress": 0,
    "isSelfBladeRebooting": null,
    "bladeProgresss": [
      {
        "bladeUUID": "386988fe-72fe-41e0-a373-7a73fea5d16e",
        "hostName": "neilscg200",
        "iterationName": "None",
        "state": "",
        "progress": 0
      }
    ],
    "previousOperationRecord": {
      "operation": "Upload",
      "success": true,
      "errorMsg": null
    },
    "clusterSubTaskState": "Completed",
    "clusterOperationBlockUI": false,
    "clusterOperationDisplayMsg": ""
  },
  "uploadPatchInfo": {
    "fileName": "scg-installer_3.2.1.0.2.ximg",
    "fileSize": 893545600,
    "fileUploadPath": null,
    "controlbladeVersion": "3.2.1.0.4",
    "allowVersions": null,
    "databladeVersion": "3.2.1.0.6",
    "apVersion": "3.2.1.99.528",
    "version": "3.2.1.0.2"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "clusterOperationProgress": {
      "description": "upgrade status",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "operation": {
          "description": "operation of clusterOperationProgress",
          "type": "string",
          "enum": [
            "None",
            "Join",
            "Backup",
            "Restore",
            "Upload",
            "Upgrade",
            "BackupAndUpgrade",
            "RemoveBlade",
            "ChangeBladeIP",
            "DiskSnapshot",
            "UploadVDPFirmware",
            "UploadAPFirmware",
            "AddAPFirmware",
            "AddLteFirmware"
          ]
        },
        "overallProgress": {
          "description": "overallProgress of clusterOperationProgress",
          "type": "integer"
        },
        "previousOperationRecord": {
          "description": "previousOperationRecord of clusterOperationProgress",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "operation": {
              "description": "operation of previousOperationRecord",
              "type": "string",
              "enum": [
                "None",
                "Join",
                "Backup",
                "Restore",
                "Upload",
                "Upgrade",
                "BackupAndUpgrade",
                "RemoveBlade",
                "ChangeBladeIP",
                "DiskSnapshot",
                "UploadVDPFirmware",
                "UploadAPFirmware",
                "AddAPFirmware",
                "AddLteFirmware"
              ]
            },
            "success": {
              "description": "success of previousOperationRecord",
              "type": "boolean"
            },
            "errorMsg": {
              "description": "errorMsg of previousOperationRecord",
              "type": "string"
            }
          }
        },
        "isSelfBladeRebooting": {
          "description": "isSelfBladeRebooting of clusterOperationProgress",
          "type": "boolean"
        },
        "bladeProgresss": {
          "description": "bladeProgressMap of clusterOperationProgress",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "bladeUUID": {
                "description": "bladeUUID of bladeProgress",
                "type": "string"
              },
              "hostName": {
                "description": "hostName of bladeProgress",
                "type": "string"
              },
              "iterationName": {
                "description": "iterationName of bladeProgress",
                "type": "string"
              },
              "state": {
                "description": "state of bladeProgress",
                "type": "string"
              },
              "progress": {
                "description": "progress of bladeProgress",
                "type": "integer"
              }
            }
          }
        },
        "clusterSubTaskState": {
          "description": "clusterSubTaskState of clusterOperationProgress",
          "type": "string",
          "enum": [
            "None",
            "Running",
            "Failed",
            "Completed"
          ]
        },
        "clusterOperationBlockUI": {
          "description": "clusterOperationBlockUI of clusterOperationProgress",
          "type": "boolean"
        },
        "clusterOperationDisplayMsg": {
          "description": "clusterOperationDisplayMsg of clusterOperationProgress",
          "type": "string"
        }
      }
    },
    "uploadPatchInfo": {
      "description": "upgrade patch info",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "fileName": {
          "description": "fileName of uploadPatchInfo",
          "type": "string"
        },
        "fileSize": {
          "description": "fileSize of uploadPatchInfo",
          "type": "number"
        },
        "fileUploadPath": {
          "description": "fileUploadPath of uploadPatchInfo",
          "type": "string"
        },
        "controlbladeVersion": {
          "description": "controlbladeVersion of uploadPatchInfo",
          "type": "string"
        },
        "databladeVersion": {
          "description": "databladeVersion of uploadPatchInfo",
          "type": "string"
        },
        "apVersion": {
          "description": "apVersion of uploadPatchInfo",
          "type": "string"
        },
        "version": {
          "description": "version of uploadPatchInfo",
          "type": "string"
        },
        "allowVersions": {
          "description": "allowVersions of uploadPatchInfo",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}

Retrive Upgrade History

GET/v11_1/upgrade/history

Use this API command to retrive upgrade history.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

timezone
string (optional) 
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "startTime": "2015/10/15 02:48:38",
      "version": "3.2.1.0.1",
      "cbVersion": "3.2.1.0.20151014063356",
      "dpVersion": "3.2.1.0.20",
      "apFwVersion": "3.2.1.99.537",
      "oldVersion": "3.2.1.0.1",
      "oldCbVersion": "3.2.1.0.20151014063356",
      "oldDpVersion": "3.2.1.0.20",
      "oldApFwVersion": "3.2.1.99.537",
      "fileName": "Fresh Installation",
      "elapsedSeconds": 772
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "startTime": {
            "description": "startTime of the upgrade history",
            "type": "string"
          },
          "version": {
            "description": "version of the upgrade history",
            "type": "string"
          },
          "cbVersion": {
            "description": "cbVersion of the upgrade history",
            "type": "string"
          },
          "dpVersion": {
            "description": "dpVersion of the upgrade history",
            "type": "string"
          },
          "apFwVersion": {
            "description": "apFwVersion of the upgrade history",
            "type": "string"
          },
          "oldVersion": {
            "description": "oldVersion of the upgrade history",
            "type": "string"
          },
          "oldCbVersion": {
            "description": "oldCbVersion of the upgrade history",
            "type": "string"
          },
          "oldDpVersion": {
            "description": "oldDpVersion of the upgrade history",
            "type": "string"
          },
          "oldApFwVersion": {
            "description": "oldApFwVersion of the upgrade history",
            "type": "string"
          },
          "fileName": {
            "description": "fileName of the upgrade history",
            "type": "string"
          },
          "elapsedSeconds": {
            "description": "elapsedSeconds of the upgrade history",
            "type": "integer",
            "format": "int64"
          }
        }
      }
    }
  }
}

Retrive Uploaded AP Patch File Info

GET/v11_1/apPatch

Use this API command to retrive uploaded AP patch file info.

Response  200
HideShow
Body
{
  "fileName": "scg-ap-3.6.1.0-6.noarch.patch",
  "fileSize": 79673580,
  "apVersion": "3.6.1.0.6",
  "apModels": [
    "C110",
    "C500",
    "FZM300",
    "FZP300",
    "H320",
    "H500",
    "H510",
    "R300",
    "R310",
    "R500",
    "R500E",
    "R510",
    "R600",
    "R610",
    "R700",
    "R710",
    "R720",
    "T300",
    "T300E",
    "T301N",
    "T301S",
    "T504",
    "T610",
    "T610S",
    "T710",
    "T710S",
    "ZF7055",
    "ZF7352",
    "ZF7372",
    "ZF7372-E",
    "ZF7781CM",
    "ZF7782",
    "ZF7782-E",
    "ZF7782-N",
    "ZF7782-S",
    "ZF7982"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "fileName": {
      "description": "file name of the upload file",
      "type": "string"
    },
    "fileSize": {
      "description": "file size(Byte) of the upload file",
      "type": "integer",
      "format": "int64"
    },
    "apVersion": {
      "description": "ApFwVersion of the upload file",
      "type": "string"
    },
    "apModels": {
      "description": "AP Models of the upload file",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Retrive AP Patch Cluster Progress Status

GET/v11_1/apPatch/status

Use this API command to retrive cluster progress status.

Response  200
HideShow
Body
{
  "clusterOperationProgress": {
    "operation": "None",
    "overallProgress": 0,
    "previousOperationRecord": {
      "operation": "UploadAPFirmware",
      "success": true,
      "errorMsg": null
    }
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "clusterOperationProgress": {
      "description": "AP Apply status",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "operation": {
          "description": "operation of clusterOperationProgress",
          "type": "string",
          "enum": [
            "None",
            "Join",
            "Backup",
            "Restore",
            "Upload",
            "Upgrade",
            "BackupAndUpgrade",
            "RemoveBlade",
            "ChangeBladeIP",
            "DiskSnapshot",
            "UploadVDPFirmware",
            "UploadAPFirmware",
            "AddAPFirmware",
            "AddLteFirmware"
          ]
        },
        "overallProgress": {
          "description": "overallProgress of clusterOperationProgress",
          "type": "integer"
        },
        "previousOperationRecord": {
          "description": "previousOperationRecord of clusterOperationProgress",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "operation": {
              "description": "operation of previousOperationRecord",
              "type": "string",
              "enum": [
                "None",
                "Join",
                "Backup",
                "Restore",
                "Upload",
                "Upgrade",
                "BackupAndUpgrade",
                "RemoveBlade",
                "ChangeBladeIP",
                "DiskSnapshot",
                "UploadVDPFirmware",
                "UploadAPFirmware",
                "AddAPFirmware",
                "AddLteFirmware"
              ]
            },
            "success": {
              "description": "success of previousOperationRecord",
              "type": "boolean"
            },
            "errorMsg": {
              "description": "errorMsg of previousOperationRecord",
              "type": "string"
            }
          }
        }
      }
    }
  }
}

Retrive AP Patch History

GET/v11_1/apPatch/history

Use this API command to retrive AP patch history.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

timezone
string (optional) 
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "startDateTime": "2017/10/16 01:43:35",
      "fileName": "scg-ap-3.6.1.0-23.noarch.patch",
      "apFwVersion": "3.6.1.0.23",
      "apModelList": [
        "C110",
        "C500",
        "FZM300",
        "FZP300",
        "H320",
        "H500",
        "H510",
        "R300",
        "R310",
        "R500",
        "R500E",
        "R510",
        "R600",
        "R610",
        "R700",
        "R710",
        "R720",
        "T300",
        "T300E",
        "T301N",
        "T301S",
        "T504",
        "T610",
        "T610S",
        "T710",
        "T710S",
        "ZF7055",
        "ZF7352",
        "ZF7372",
        "ZF7372-E",
        "ZF7781CM",
        "ZF7782",
        "ZF7782-E",
        "ZF7782-N",
        "ZF7782-S",
        "ZF7982"
      ]
    },
    {
      "startDateTime": "2017/10/13 10:23:21",
      "fileName": "scg-ap-3.6.1.0-6.noarch.patch",
      "apFwVersion": "3.6.1.0.6",
      "apModelList": [
        "C110",
        "C500",
        "FZM300",
        "FZP300",
        "H320",
        "H500",
        "H510",
        "R300",
        "R310",
        "R500",
        "R500E",
        "R510",
        "R600",
        "R610",
        "R700",
        "R710",
        "R720",
        "T300",
        "T300E",
        "T301N",
        "T301S",
        "T504",
        "T610",
        "T610S",
        "T710",
        "T710S",
        "ZF7055",
        "ZF7352",
        "ZF7372",
        "ZF7372-E",
        "ZF7781CM",
        "ZF7782",
        "ZF7782-E",
        "ZF7782-N",
        "ZF7782-S",
        "ZF7982"
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "startDateTime": {
            "description": "startDateTime of the AP Patch history",
            "type": "string"
          },
          "fileName": {
            "description": "file name of the AP Patch history",
            "type": "string"
          },
          "apFwVersion": {
            "description": "apFwVersion of the AP Patch history",
            "type": "string"
          },
          "apModelList": {
            "description": "AP Models of the AP Patch history",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

Get current cluster state

GET/v11_1/cluster/state

Use this API command to get current cluster, blade, and management service states

Response  200
HideShow
Body
{
  "clusterName": "SCG200-T0828",
  "clusterState": "In_Service",
  "clusterRole": "Leader",
  "currentNodeId": "b8b28097-be93-463a-889b-e6b754017527",
  "currentNodeName": "node1",
  "nodeStateList": [
    {
      "nodeId": "f694dc0b-70db-4146-b90b-c607f08ac84a",
      "nodeName": "node02",
      "nodeState": "In_Service"
    },
    {
      "nodeId": "b8b28097-be93-463a-889b-e6b754017527",
      "nodeName": "node1",
      "nodeState": "In_Service"
    }
  ],
  "managementServiceStateList": [
    {
      "nodeId": "b8b28097-be93-463a-889b-e6b754017527",
      "nodeName": "node1",
      "managementServiceState": "In_Service"
    },
    {
      "nodeId": "f694dc0b-70db-4146-b90b-c607f08ac84a",
      "nodeName": "node02",
      "managementServiceState": "In_Service"
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "clusterName": {
      "description": "cluster name",
      "type": "string"
    },
    "clusterState": {
      "description": "cluster state",
      "type": "string",
      "enum": [
        "In_Service",
        "Out_Of_Service",
        "Maintenance",
        "Read_Only",
        "NetworkPartitionSuspected"
      ]
    },
    "clusterRole": {
      "description": "The cluster role of the current controller node",
      "type": "string",
      "enum": [
        "Leader",
        "Follower"
      ]
    },
    "currentNodeId": {
      "description": "Identifier of the current controller node",
      "type": "string"
    },
    "currentNodeName": {
      "description": "The name of the current controller node ",
      "type": "string"
    },
    "nodeStateList": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "nodeId": {
            "description": "Identifier of the controller node",
            "type": "string"
          },
          "nodeName": {
            "type": "string"
          },
          "nodeState": {
            "description": "node state",
            "type": "string",
            "enum": [
              "Out_Of_Service",
              "In_Service"
            ]
          }
        }
      }
    },
    "managementServiceStateList": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "nodeId": {
            "description": "Identifier of the controller node",
            "type": "string"
          },
          "nodeName": {
            "description": "node name",
            "type": "string"
          },
          "managementServiceState": {
            "description": "management service state",
            "type": "string",
            "enum": [
              "Out_Of_Service",
              "In_Service"
            ]
          }
        }
      }
    }
  }
}

Get Cluster Redundancy

GET/v11_1/cluster/geoRedundancy

Get cluster redundancy settings.

Response  200
HideShow
Body
‧ Sample : Active-Standby type of cluster redundancy settings
{
    "clusterRedundancyEnabled" : true,
    "clusterRedundancyType" : "Active-Standby",
    "standbyAdminPassword" : "admin!234",
    "managementEntryList" : [ {
        "ip" : "172.17.18.111",
        "port" : "8443"
    }, {
        "ip" : "172.17.18.222",
        "port" : "8443"
    } ],
    "activeClusterList" : null,
    "scheduleSyncUpEnabled" : true,
    "interval" : null,
    "dateOfMonth" : null,
    "dayOfWeek" : null,
    "hour" : 0,
    "minute" : null
}
‧ Sample : Active-Active type of cluster redundancy settings
{
    "clusterRedundancyEnabled" : true,
    "clusterRedundancyType" : "Active-Active",
    "standbyAdminPassword" : null,
    "managementEntryList" : null,
    "activeClusterList" : [ {
        "priority" : 1,
        "targetClusterAdminPassword" : "admin!234",
        "managementEntryList" : [ {
            "ip" : "172.17.88.111",
            "port" : "8443"
        } ]
    }, {
        "priority" : 2,
        "targetClusterAdminPassword" : "admin!234",
        "managementEntryList" : [ {
            "ip" : "172.17.89.111",
            "port" : "8443"
        } ]
    }, {
        "priority" : 3,
        "targetClusterAdminPassword" : "admin!234",
        "managementEntryList" : [ {
            "ip" : "172.17.90.111",
            "port" : "8443"
        }, {
            "ip" : "172.17.90.222",
            "port" : "8443"
        } ]
    } ],
    "scheduleSyncUpEnabled" : true,
    "hour" : 13,
    "interval" : "WEEKLY",
    "dayOfWeek" : "SUNDAY",
    "dateOfMonth" : null,
    "minute" : 30
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "clusterRedundancyEnabled" : {
            "description" : "Cluster redundancy enabled",
            "type" : "boolean"
        },
        "clusterRedundancyType" : {
            "description" : "Cluster redundancy type",
            "type" : "string"
        },
        "standbyAdminPassword" : {
            "description" : "Password of admin account of standby cluster (Active-Standby only)",
            "type" : "string"
        },
        "managementEntryList" : {
            "description" : "Management entry list of standby cluster (Active-Standby only)",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "ip" : {
                        "description" : "Management IP",
                        "type" : "string"
                    },
                    "port" : {
                        "description" : "Management port",
                        "type" : "string"
                    }
                }
            }
        },
        "activeClusterList" : {
            "description" : "A list of target active clusters (Active-Active only)",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "priority" : {
                        "description" : "Priority of target active cluster",
                        "type" : "integer"
                    },
                    "targetClusterAdminPassword" : {
                        "description" : "Password of admin account of target active cluster",
                        "type" : "string"
                    },
                    "managementEntryList" : {
                        "description" : "Management entry list of target active cluster",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "ip" : {
                                    "description" : "Management IP",
                                    "type" : "string"
                                },
                                "port" : {
                                    "description" : "Management port",
                                    "type" : "string"
                                }
                            }
                        }
                    }
                }
            }
        },
        "scheduleSyncUpEnabled" : {
            "description" : "Scheduled configuration sync enabled",
            "type" : "boolean"
        },
        "interval" : {
            "description" : "Schedule interval (Active-Active only)",
            "type" : "string",
            "enum" : [ "MONTHLY", "WEEKLY", "DAILY", "HOURLY" ]
        },
        "dateOfMonth" : {
            "description" : "Scheduled date of the month (1-31) (Active-Active only)",
            "type" : "integer"
        },
        "dayOfWeek" : {
            "description" : "Scheduled day of the week (Active-Active only)",
            "type" : "string",
            "enum" : [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ]
        },
        "hour" : {
            "description" : "Schedule sync time in daily hour (0-23)",
            "type" : "integer"
        },
        "minute" : {
            "description" : "Schedule sync time in minute (Active-Active only)",
            "type" : "integer"
        }
    }
}

Upload

POST/v11_1/configuration/upload

Upload system configuration file.

Request
HideShow
Headers
Content-Type: multipart/form-data
Response  204

Cluster backup

POST/v11_1/cluster/backup

Backup cluster.

Response  204

System configuration backup

POST/v11_1/configuration/backup

Backup system configuration.

Response  201
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

System configuration restore

POST/v11_1/configuration/restore/{id}

Restore system configuration with specified backupUUID.

Request
HideShow
Body
{
  "executeWarningValidate": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "executeWarningValidate": {
      "description": "Validation of AP firmware version",
      "type": "boolean",
      "default": true
    }
  },
  "required": [
    "executeWarningValidate"
  ]
}
Response  204

Cluster restore

POST/v11_1/cluster/restore/{id:.+}

Restore cluster backup by ID.

Response  204

Upload File

POST/v11_1/upgrade/upload

Use this API command to upload patch file.

Request
HideShow
Headers
Content-Type: multipart/form-data
Response  200
HideShow
Body
{
  "clusterOperationProgress": {
    "operation": "None",
    "overallProgress": 0,
    "isSelfBladeRebooting": null,
    "bladeProgresss": [
      {
        "bladeUUID": "386988fe-72fe-41e0-a373-7a73fea5d16e",
        "hostName": "neilscg200",
        "iterationName": "None",
        "state": "",
        "progress": 0
      }
    ],
    "previousOperationRecord": {
      "operation": "Upload",
      "success": true,
      "errorMsg": null
    },
    "clusterSubTaskState": "Completed",
    "clusterOperationBlockUI": false,
    "clusterOperationDisplayMsg": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "clusterOperationProgress": {
      "description": "upgrade status",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "operation": {
          "description": "operation of clusterOperationProgress",
          "type": "string",
          "enum": [
            "None",
            "Join",
            "Backup",
            "Restore",
            "Upload",
            "Upgrade",
            "BackupAndUpgrade",
            "RemoveBlade",
            "ChangeBladeIP",
            "DiskSnapshot",
            "UploadVDPFirmware",
            "UploadAPFirmware",
            "AddAPFirmware",
            "AddLteFirmware"
          ]
        },
        "overallProgress": {
          "description": "overallProgress of clusterOperationProgress",
          "type": "integer"
        },
        "previousOperationRecord": {
          "description": "previousOperationRecord of clusterOperationProgress",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "operation": {
              "description": "operation of previousOperationRecord",
              "type": "string",
              "enum": [
                "None",
                "Join",
                "Backup",
                "Restore",
                "Upload",
                "Upgrade",
                "BackupAndUpgrade",
                "RemoveBlade",
                "ChangeBladeIP",
                "DiskSnapshot",
                "UploadVDPFirmware",
                "UploadAPFirmware",
                "AddAPFirmware",
                "AddLteFirmware"
              ]
            },
            "success": {
              "description": "success of previousOperationRecord",
              "type": "boolean"
            },
            "errorMsg": {
              "description": "errorMsg of previousOperationRecord",
              "type": "string"
            }
          }
        },
        "isSelfBladeRebooting": {
          "description": "isSelfBladeRebooting of clusterOperationProgress",
          "type": "boolean"
        },
        "bladeProgresss": {
          "description": "bladeProgressMap of clusterOperationProgress",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "bladeUUID": {
                "description": "bladeUUID of bladeProgress",
                "type": "string"
              },
              "hostName": {
                "description": "hostName of bladeProgress",
                "type": "string"
              },
              "iterationName": {
                "description": "iterationName of bladeProgress",
                "type": "string"
              },
              "state": {
                "description": "state of bladeProgress",
                "type": "string"
              },
              "progress": {
                "description": "progress of bladeProgress",
                "type": "integer"
              }
            }
          }
        },
        "clusterSubTaskState": {
          "description": "clusterSubTaskState of clusterOperationProgress",
          "type": "string",
          "enum": [
            "None",
            "Running",
            "Failed",
            "Completed"
          ]
        },
        "clusterOperationBlockUI": {
          "description": "clusterOperationBlockUI of clusterOperationProgress",
          "type": "boolean"
        },
        "clusterOperationDisplayMsg": {
          "description": "clusterOperationDisplayMsg of clusterOperationProgress",
          "type": "string"
        }
      }
    }
  }
}

System Upgrade

POST/v11_1/upgrade

Use this API command to do system upgrade.

Response  200
HideShow
Body
{
  "clusterOperationProgress": {
    "operation": "None",
    "overallProgress": 0,
    "isSelfBladeRebooting": null,
    "bladeProgresss": [
      {
        "bladeUUID": "386988fe-72fe-41e0-a373-7a73fea5d16e",
        "hostName": "neilscg200",
        "iterationName": "None",
        "state": "",
        "progress": 0
      }
    ],
    "previousOperationRecord": {
      "operation": "Upload",
      "success": true,
      "errorMsg": null
    },
    "clusterSubTaskState": "Completed",
    "clusterOperationBlockUI": false,
    "clusterOperationDisplayMsg": ""
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "clusterOperationProgress": {
      "description": "upgrade status",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "operation": {
          "description": "operation of clusterOperationProgress",
          "type": "string",
          "enum": [
            "None",
            "Join",
            "Backup",
            "Restore",
            "Upload",
            "Upgrade",
            "BackupAndUpgrade",
            "RemoveBlade",
            "ChangeBladeIP",
            "DiskSnapshot",
            "UploadVDPFirmware",
            "UploadAPFirmware",
            "AddAPFirmware",
            "AddLteFirmware"
          ]
        },
        "overallProgress": {
          "description": "overallProgress of clusterOperationProgress",
          "type": "integer"
        },
        "previousOperationRecord": {
          "description": "previousOperationRecord of clusterOperationProgress",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "operation": {
              "description": "operation of previousOperationRecord",
              "type": "string",
              "enum": [
                "None",
                "Join",
                "Backup",
                "Restore",
                "Upload",
                "Upgrade",
                "BackupAndUpgrade",
                "RemoveBlade",
                "ChangeBladeIP",
                "DiskSnapshot",
                "UploadVDPFirmware",
                "UploadAPFirmware",
                "AddAPFirmware",
                "AddLteFirmware"
              ]
            },
            "success": {
              "description": "success of previousOperationRecord",
              "type": "boolean"
            },
            "errorMsg": {
              "description": "errorMsg of previousOperationRecord",
              "type": "string"
            }
          }
        },
        "isSelfBladeRebooting": {
          "description": "isSelfBladeRebooting of clusterOperationProgress",
          "type": "boolean"
        },
        "bladeProgresss": {
          "description": "bladeProgressMap of clusterOperationProgress",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "bladeUUID": {
                "description": "bladeUUID of bladeProgress",
                "type": "string"
              },
              "hostName": {
                "description": "hostName of bladeProgress",
                "type": "string"
              },
              "iterationName": {
                "description": "iterationName of bladeProgress",
                "type": "string"
              },
              "state": {
                "description": "state of bladeProgress",
                "type": "string"
              },
              "progress": {
                "description": "progress of bladeProgress",
                "type": "integer"
              }
            }
          }
        },
        "clusterSubTaskState": {
          "description": "clusterSubTaskState of clusterOperationProgress",
          "type": "string",
          "enum": [
            "None",
            "Running",
            "Failed",
            "Completed"
          ]
        },
        "clusterOperationBlockUI": {
          "description": "clusterOperationBlockUI of clusterOperationProgress",
          "type": "boolean"
        },
        "clusterOperationDisplayMsg": {
          "description": "clusterOperationDisplayMsg of clusterOperationProgress",
          "type": "string"
        }
      }
    }
  }
}

Upload AP Patch File

POST/v11_1/apPatch/file

Use this API command to upload AP Patch File.

Request
HideShow
Headers
Content-Type: multipart/form-data
Response  204

Apply AP Patch

POST/v11_1/apPatch

Use this API command to apply AP patch.

Response  200
HideShow
Body
{
  "clusterOperationProgress": {
    "operation": "None",
    "overallProgress": 0,
    "previousOperationRecord": {
      "operation": "UploadAPFirmware",
      "success": true,
      "errorMsg": null
    }
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "clusterOperationProgress": {
      "description": "AP Apply status",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "operation": {
          "description": "operation of clusterOperationProgress",
          "type": "string",
          "enum": [
            "None",
            "Join",
            "Backup",
            "Restore",
            "Upload",
            "Upgrade",
            "BackupAndUpgrade",
            "RemoveBlade",
            "ChangeBladeIP",
            "DiskSnapshot",
            "UploadVDPFirmware",
            "UploadAPFirmware",
            "AddAPFirmware",
            "AddLteFirmware"
          ]
        },
        "overallProgress": {
          "description": "overallProgress of clusterOperationProgress",
          "type": "integer"
        },
        "previousOperationRecord": {
          "description": "previousOperationRecord of clusterOperationProgress",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "operation": {
              "description": "operation of previousOperationRecord",
              "type": "string",
              "enum": [
                "None",
                "Join",
                "Backup",
                "Restore",
                "Upload",
                "Upgrade",
                "BackupAndUpgrade",
                "RemoveBlade",
                "ChangeBladeIP",
                "DiskSnapshot",
                "UploadVDPFirmware",
                "UploadAPFirmware",
                "AddAPFirmware",
                "AddLteFirmware"
              ]
            },
            "success": {
              "description": "success of previousOperationRecord",
              "type": "boolean"
            },
            "errorMsg": {
              "description": "errorMsg of previousOperationRecord",
              "type": "string"
            }
          }
        }
      }
    }
  }
}

Modify Auto Export Backup

PATCH/v11_1/configurationSettings/autoExportBackup

Modify Auto Export Backup Settings.

Request
HideShow
Body
{
  "enableAutoExportBackup": true,
  "ftpNamePrefix": "File prefix name",
  "ftpServer": "FTP server name"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enableAutoExportBackup": {
      "description": "enable auto export backup",
      "type": "boolean"
    },
    "ftpNamePrefix": {
      "description": "file prefix name",
      "type": "string"
    },
    "ftpServer": {
      "description": "ftp server name",
      "type": "string"
    }
  }
}
Response  204

Modify Schedule Backup Setting

PATCH/v11_1/configurationSettings/scheduleBackup

Modify Schedule Backup Setting.

Request
HideShow
Body
{
  "enableScheduleBackup": true,
  "interval": "WEEKLY",
  "dayOfWeek": "MONDAY",
  "hour": 2,
  "minute": 15
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enableScheduleBackup": {
      "description": "enable schedule backup",
      "type": "boolean"
    },
    "interval": {
      "description": "schedule interval",
      "type": "string",
      "enum": [
        "MONTHLY",
        "WEEKLY",
        "DAILY"
      ]
    },
    "dayOfWeek": {
      "description": "day of the week",
      "type": "string",
      "enum": [
        "SUNDAY",
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY",
        "SATURDAY"
      ]
    },
    "dateOfMonth": {
      "description": "date of the month",
      "type": "integer"
    },
    "hour": {
      "description": "hour",
      "type": "integer"
    },
    "minute": {
      "description": "minute",
      "type": "integer"
    }
  }
}
Response  204

Delete

DELETE/v11_1/configuration/{id}

Delete system configuration file.

Response  204

Delete

DELETE/v11_1/cluster/{id:.+}

Delete cluster backup by ID.

Response  204

Traffic Class Profile

Retrieve

GET/v11_1/rkszones/{zoneId}/trafficClassProfile/{id}

Use this API command to retrieve a Traffic Class Profile of zone.

Response  200
HideShow
Body
{
  "name": "tcProfile_01",
  "description": "tcProfile_01",
  "zoneId": "f77a8816-3049-40cd-8484-82919275ddc3",
  "trafficClasses": [
    {
      "id": "tc_01",
      "whitelists": "www.ruckuswireless.com"
    },
    {
      "id": "tc_02",
      "whitelists": "www.google.com,www.apple.com"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "zoneId": {
      "description": "Zone Id of Traffic Class Profile",
      "type": "string"
    },
    "id": {
      "description": "Identifier of the Traffic Class Profile",
      "type": "string"
    },
    "name": {
      "description": "Name of the Traffic Class Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Traffic Class Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "trafficClasses": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the Traffic Class",
            "type": "string"
          },
          "whitelists": {
            "description": "White list of the Traffic Class Profile. The multiple entries need to be separated by comma (,)",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve List

GET/v11_1/rkszones/{zoneId}/trafficClassProfile

Use this API command to retrieve a list of Traffic Class Profile of a zone.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "name": "tcProfile_01",
      "description": "tcProfile_01",
      "zoneId": "f77a8816-3049-40cd-8484-82919275ddc3",
      "trafficClasses": [
        {
          "id": "tc_01",
          "whitelists": "www.ruckuswireless.com"
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "zoneId": {
            "description": "Zone Id of Traffic Class Profile",
            "type": "string"
          },
          "id": {
            "description": "Identifier of the Traffic Class Profile",
            "type": "string"
          },
          "name": {
            "description": "Name of the Traffic Class Profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the Traffic Class Profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "trafficClasses": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "id": {
                  "description": "Identifier of the Traffic Class",
                  "type": "string"
                },
                "whitelists": {
                  "description": "White list of the Traffic Class Profile. The multiple entries need to be separated by comma (,)",
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Retrieve List

POST/v11_1/query/services/trafficClassProfile

Retrieve a list of Traffic Class Profile. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "name": "tcProfile_01",
      "description": "tcProfile_01",
      "zoneId": "f77a8816-3049-40cd-8484-82919275ddc3",
      "trafficClasses": [
        {
          "id": "tc_01",
          "whitelists": "www.ruckuswireless.com"
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "zoneId": {
            "description": "Zone Id of Traffic Class Profile",
            "type": "string"
          },
          "id": {
            "description": "Identifier of the Traffic Class Profile",
            "type": "string"
          },
          "name": {
            "description": "Name of the Traffic Class Profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the Traffic Class Profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "trafficClasses": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "id": {
                  "description": "Identifier of the Traffic Class",
                  "type": "string"
                },
                "whitelists": {
                  "description": "White list of the Traffic Class Profile. The multiple entries need to be separated by comma (,)",
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  }
}

Create

POST/v11_1/rkszones/{zoneId}/trafficClassProfile

Use this API command to create a new Traffic Class Profile of a zone.

Request
HideShow
Body
{
  "name": "tcProfile_01",
  "description": "tcProfile_01",
  "trafficClasses": [
    {
      "id": "tc_01",
      "whitelists": "www.ruckuswireless.com"
    },
    {
      "id": "tc_02",
      "whitelists": "www.google.com,www.apple.com"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Traffic Class Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "description": {
      "description": "Description of the Traffic Class Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "trafficClasses": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the Traffic Class",
            "type": "string"
          },
          "whitelists": {
            "description": "White list of the Traffic Class Profile. The multiple entries need to be separated by comma (,)",
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "name",
    "trafficClasses"
  ]
}
Response  201
HideShow
Body
{
  "id": "fb8a0052-aafa-11e6-9e20-0242f6ac998f"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v11_1/rkszones/{zoneId}/trafficClassProfile/{id}

Use this API command to modify Traffic Class Profile of a zone.

Request
HideShow
Body
{
  "name": "tcProfile_01",
  "description": "tcProfile_01",
  "trafficClasses": [
    {
      "id": "tc_01",
      "whitelists": "www.ruckuswireless.com"
    },
    {
      "id": "tc_02",
      "whitelists": "www.google.com,www.apple.com"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Traffic Class Profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "description": {
      "description": "Description of the Traffic Class Profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "trafficClasses": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the Traffic Class",
            "type": "string"
          },
          "whitelists": {
            "description": "White list of the Traffic Class Profile. The multiple entries need to be separated by comma (,)",
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "name",
    "trafficClasses"
  ]
}
Response  204

Delete

DELETE/v11_1/rkszones/{zoneId}/trafficClassProfile/{id}

Use this API command to delete a Traffic Class Profile of a zone.

Response  204

Bulk Delete

DELETE/v11_1/rkszones/{zoneId}/trafficClassProfile

Use this API command to bulk delete Traffic Class Profiles of a zone.

Request
HideShow
Body
{
  "idList": [
    "1c942d00-4f36-11e6-8512-0a0027000000",
    "0a782052-96d5-738b-afce-aa8157abd30c"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

SystemIPsec

Retrieve System IPSec

GET/v11_1/systemIpsec

Use this API command to retrieve the System IPSec.

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ipSecEnabled": {
      "description": "Enable System IPSec",
      "type": "boolean"
    },
    "securityGateway": {
      "description": "Security gateway IP",
      "type": "string"
    },
    "subnetMask": {
      "description": "Subnet Mask of security gateway",
      "type": "string"
    },
    "authType": {
      "description": "Authentication type",
      "type": "string"
    },
    "preSharedKey": {
      "description": "Pre-shared key",
      "type": "string"
    },
    "remoteId": {
      "description": "The IP of IPSec receiver",
      "type": "string"
    },
    "scgCertId": {
      "description": "SCG client certification id.",
      "type": "string"
    },
    "ikeProposals": {
      "description": "Proposal of Internet Key Exchange",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "encAlg": {
            "description": "Encrytion algorithm",
            "type": "string"
          },
          "authAlg": {
            "description": "Authentication algorithm",
            "type": "string"
          }
        },
        "required": [
          "encAlg",
          "authAlg"
        ]
      }
    },
    "ikeRekeyDisabled": {
      "description": "Disable rekey mechanisam of Internet Key Exchange",
      "type": "boolean"
    },
    "ikeRekeyTime": {
      "description": "Rekey time of Internet Key Exchange",
      "type": "integer"
    },
    "ikeRekeyTimeUnit": {
      "description": "Rekey time unit of Internet Key Exchange",
      "type": "string"
    },
    "espProposals": {
      "description": "Proposal of Encapsulating Security Payload",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "encAlg": {
            "description": "Encrytion algorithm",
            "type": "string"
          },
          "authAlg": {
            "description": "Authentication algorithm",
            "type": "string"
          }
        },
        "required": [
          "encAlg",
          "authAlg"
        ]
      }
    },
    "espRekeyDisabled": {
      "description": "Disable rekey mechanisam of Encapsulating Security Payload",
      "type": "boolean"
    },
    "espRekeyTime": {
      "description": "Rekey time of Encapsulating Security Payload",
      "type": "integer"
    },
    "espRekeyTimeUnit": {
      "description": "Rekey time unit of Encapsulating Security Payload",
      "type": "string"
    },
    "ocspEnabled": {
      "description": "Enable OCSP",
      "type": "boolean"
    },
    "ocspAction": {
      "description": "OCSP action option",
      "type": "string",
      "enum": [
        "CERT_FIRST",
        "USER_SPECIFIED_FIRST"
      ],
      "default": "CERT_FIRST"
    },
    "trustChainProfileId": {
      "description": "Assign trust chain profile id",
      "type": "string"
    },
    "certSubject": {
      "description": "Assign specific cert subject",
      "type": "string"
    },
    "ocspServerUri": {
      "description": "The URI of OCSP server",
      "type": "string"
    }
  }
}

Modify System IPSec

PUT/v11_1/systemIpsec

Use this API command to modify the System IPSec.

Request
HideShow
Body
{
  "ipSecEnabled": true,
  "securityGateway": "1.1.1.1",
  "subnetMask": "255.255.255.0",
  "authType": "PSK",
  "preSharedKey": "1234561111",
  "espRekeyDisabled": false,
  "espRekeyTime": 2,
  "espRekeyTimeUnit": "HOUR",
  "ocspEnabled": true,
  "ocspAction": "CERT_FIRST",
  "espProposals": [
    {
      "encAlg": "AES128",
      "authAlg": "SHA1"
    }
  ],
  "ikeRekeyDisabled": false,
  "ikeRekeyTime": 10,
  "ikeRekeyTimeUnit": "HOUR",
  "ikeProposals": [
    {
      "encAlg": "AES128",
      "authAlg": "SHA1"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ipSecEnabled": {
      "description": "Enable System IPSec",
      "type": "boolean"
    },
    "securityGateway": {
      "description": "Security gateway IP",
      "type": "string"
    },
    "subnetMask": {
      "description": "Subnet Mask of security gateway",
      "type": "string"
    },
    "authType": {
      "description": "Authentication type",
      "type": "string"
    },
    "preSharedKey": {
      "description": "Pre-shared key",
      "type": "string"
    },
    "remoteId": {
      "description": "The IP of IPSec receiver",
      "type": "string"
    },
    "scgCertId": {
      "description": "SCG client certification id.",
      "type": "string"
    },
    "ikeProposals": {
      "description": "Proposal of Internet Key Exchange",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "encAlg": {
            "description": "Encrytion algorithm",
            "type": "string"
          },
          "authAlg": {
            "description": "Authentication algorithm",
            "type": "string"
          }
        },
        "required": [
          "encAlg",
          "authAlg"
        ]
      }
    },
    "ikeRekeyDisabled": {
      "description": "Disable rekey mechanisam of Internet Key Exchange",
      "type": "boolean"
    },
    "ikeRekeyTime": {
      "description": "Rekey time of Internet Key Exchange",
      "type": "integer"
    },
    "ikeRekeyTimeUnit": {
      "description": "Rekey time unit of Internet Key Exchange",
      "type": "string"
    },
    "espProposals": {
      "description": "Proposal of Encapsulating Security Payload",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "encAlg": {
            "description": "Encrytion algorithm",
            "type": "string"
          },
          "authAlg": {
            "description": "Authentication algorithm",
            "type": "string"
          }
        },
        "required": [
          "encAlg",
          "authAlg"
        ]
      }
    },
    "espRekeyDisabled": {
      "description": "Disable rekey mechanisam of Encapsulating Security Payload",
      "type": "boolean"
    },
    "espRekeyTime": {
      "description": "Rekey time of Encapsulating Security Payload",
      "type": "integer"
    },
    "espRekeyTimeUnit": {
      "description": "Rekey time unit of Encapsulating Security Payload",
      "type": "string"
    },
    "ocspEnabled": {
      "description": "Enable OCSP",
      "type": "boolean"
    },
    "ocspAction": {
      "description": "OCSP action option",
      "type": "string",
      "enum": [
        "CERT_FIRST",
        "USER_SPECIFIED_FIRST"
      ]
    },
    "trustChainProfileId": {
      "description": "Assign trust chain profile id",
      "type": "string"
    },
    "certSubject": {
      "description": "Assign specific cert subject",
      "type": "string"
    },
    "ocspServerUri": {
      "description": "The URI of OCSP server",
      "type": "string"
    }
  },
  "required": [
    "ipSecEnabled"
  ]
}
Response  200

Vendor Specific Attribute Profile

Get Vendor Specific Attribute Profiles

GET/v11_1/rkszones/{zoneId}/vendorSpecificAttributeProfiles

Get a ID list of vendor specific attribute profile in this Zone.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "name": "vsaProfile1",
      "id": "290a3591-c0a2-11e8-aa9d-3e573db5ed22"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total number of the profiles",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more profiles after the list that is currently displayed",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first profile returned out of the profile list",
      "type": "integer"
    },
    "list": {
      "description": "Information list of the vendor specific attribute profile",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "id": {
            "description": "Identifier of the vendor specific attribute profile",
            "type": "string"
          }
        }
      }
    }
  }
}

Get Vendor Specific Attribute Profile

GET/v11_1/rkszones/{zoneId}/vendorSpecificAttributeProfiles/{id}

Get a vendor specific attribute profile by ID.

Response  200
HideShow
Body
{
  "name": "vsaProfile1",
  "id": "290a3591-c0a2-11e8-aa9d-3e573db5ed22",
  "description": "description00001",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "zoneId": "27c492d7-0e2e-4316-89af-30893a192a1e",
  "attributes": [
    {
      "vendorId": 12345,
      "keyId": 1,
      "value": "value0",
      "type": "STRING",
      "supportedRadiusProtocol": "BOTH_AUTHENTICATION_AND_ACCOUNTING"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the vendor specific attribute profile",
      "type": "string"
    },
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "domainId": {
      "description": "Domain Id",
      "type": "string"
    },
    "zoneId": {
      "description": "Zone Id",
      "type": "string"
    },
    "attributes": {
      "description": "Vendor specific attribute list for Radius protocol",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "vendorId": {
            "description": "Vendor ID of vendor specific attribute",
            "type": "integer"
          },
          "keyId": {
            "description": "Key ID of vendor specific attribute",
            "type": "integer"
          },
          "value": {
            "description": "Value of vendor specific attribute",
            "type": "string"
          },
          "type": {
            "description": "Type of vendor specific attribute",
            "type": "string",
            "enum": [
              "INTEGER",
              "STRING"
            ]
          },
          "supportedRadiusProtocol": {
            "description": "The radius protocol to which this given vendor specific attribute will attach",
            "type": "string",
            "enum": [
              "ACCOUNTING",
              "AUTHENTICATION",
              "BOTH_AUTHENTICATION_AND_ACCOUNTING"
            ]
          }
        },
        "required": [
          "vendorId",
          "keyId",
          "value",
          "type",
          "supportedRadiusProtocol"
        ]
      }
    }
  }
}

Create Vendor Specific Attribute Profile

POST/v11_1/rkszones/{zoneId}/vendorSpecificAttributeProfiles

Create a vendor specific attribute profile.

Request
HideShow
Body
{
  "name": "vsaProfile1",
  "description": "description00001",
  "attributes": [
    {
      "vendorId": 12345,
      "type": "STRING",
      "value": "value0",
      "keyId": 1,
      "supportedRadiusProtocol": "BOTH_AUTHENTICATION_AND_ACCOUNTING"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "attributes": {
      "description": "Vendor specific attribute list for Radius protocol",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "vendorId": {
            "description": "Vendor ID of vendor specific attribute",
            "type": "integer"
          },
          "keyId": {
            "description": "Key ID of vendor specific attribute",
            "type": "integer"
          },
          "value": {
            "description": "Value of vendor specific attribute",
            "type": "string"
          },
          "type": {
            "description": "Type of vendor specific attribute",
            "type": "string",
            "enum": [
              "INTEGER",
              "STRING"
            ]
          },
          "supportedRadiusProtocol": {
            "description": "The radius protocol to which this given vendor specific attribute will attach",
            "type": "string",
            "enum": [
              "ACCOUNTING",
              "AUTHENTICATION",
              "BOTH_AUTHENTICATION_AND_ACCOUNTING"
            ]
          }
        },
        "required": [
          "vendorId",
          "keyId",
          "value",
          "type",
          "supportedRadiusProtocol"
        ]
      }
    }
  },
  "required": [
    "name",
    "attributes"
  ]
}
Response  200
HideShow
Body
{
  "id": "290a3591-c0a2-11e8-aa9d-3e573db5ed22"
}
Schema
{
  "properties": {
    "id": {
      "description": "Identifier of the vendor specific attribute profile",
      "type": "string"
    }
  }
}

Query Vendor Specific Attribute Profiles

POST/v11_1/rkszones/vendorSpecificAttributeProfiles/query

Use this API command to retrieve a list of vendor specific attribute profile by query criteria. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUTHENTICATIONTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        },
        "dpGroupFilterId": {
          "description": "Zone UUID for DP Group filter",
          "type": "string"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "name": "vsaProfile1",
      "id": "290a3591-c0a2-11e8-aa9d-3e573db5ed22",
      "description": "description00001",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "zoneId": "27c492d7-0e2e-4316-89af-30893a192a1e",
      "attributes": [
        {
          "vendorId": 12345,
          "keyId": 1,
          "value": "value0",
          "type": "STRING",
          "supportedRadiusProtocol": "BOTH_AUTHENTICATION_AND_ACCOUNTING"
        }
      ]
    }
  ],
  "extra": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "extra": {
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the vendor specific attribute profile",
            "type": "string"
          },
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "domainId": {
            "description": "Domain Id",
            "type": "string"
          },
          "zoneId": {
            "description": "Zone Id",
            "type": "string"
          },
          "attributes": {
            "description": "Vendor specific attribute list for Radius protocol",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "vendorId": {
                  "description": "Vendor ID of vendor specific attribute",
                  "type": "integer"
                },
                "keyId": {
                  "description": "Key ID of vendor specific attribute",
                  "type": "integer"
                },
                "value": {
                  "description": "Value of vendor specific attribute",
                  "type": "string"
                },
                "type": {
                  "description": "Type of vendor specific attribute",
                  "type": "string",
                  "enum": [
                    "INTEGER",
                    "STRING"
                  ]
                },
                "supportedRadiusProtocol": {
                  "description": "The radius protocol to which this given vendor specific attribute will attach",
                  "type": "string",
                  "enum": [
                    "ACCOUNTING",
                    "AUTHENTICATION",
                    "BOTH_AUTHENTICATION_AND_ACCOUNTING"
                  ]
                }
              },
              "required": [
                "vendorId",
                "keyId",
                "value",
                "type",
                "supportedRadiusProtocol"
              ]
            }
          }
        }
      }
    }
  }
}

Modify Entire Vendor Specific Attribute Profile

PUT/v11_1/rkszones/{zoneId}/vendorSpecificAttributeProfiles/{id}

Use this API command to modify entire information of a vendor specific attribute profile.

Request
HideShow
Body
{
  "name": "vsaProfile1",
  "description": "description00001",
  "attributes": [
    {
      "vendorId": 12345,
      "type": "STRING",
      "value": "value0",
      "keyId": 1,
      "supportedRadiusProtocol": "BOTH_AUTHENTICATION_AND_ACCOUNTING"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "attributes": {
      "description": "Vendor specific attribute list for Radius protocol",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "vendorId": {
            "description": "Vendor ID of vendor specific attribute",
            "type": "integer"
          },
          "keyId": {
            "description": "Key ID of vendor specific attribute",
            "type": "integer"
          },
          "value": {
            "description": "Value of vendor specific attribute",
            "type": "string"
          },
          "type": {
            "description": "Type of vendor specific attribute",
            "type": "string",
            "enum": [
              "INTEGER",
              "STRING"
            ]
          },
          "supportedRadiusProtocol": {
            "description": "The radius protocol to which this given vendor specific attribute will attach",
            "type": "string",
            "enum": [
              "ACCOUNTING",
              "AUTHENTICATION",
              "BOTH_AUTHENTICATION_AND_ACCOUNTING"
            ]
          }
        },
        "required": [
          "vendorId",
          "keyId",
          "value",
          "type",
          "supportedRadiusProtocol"
        ]
      }
    }
  },
  "required": [
    "name",
    "attributes"
  ]
}
Response  204

Delete Vendor Specific Attribute Profile

DELETE/v11_1/rkszones/{zoneId}/vendorSpecificAttributeProfiles/{id}

Use this API command to delete a vendor specific attribute profile by ID.

Response  204

Bulk Delete Vendor Specific Attribute Profile

DELETE/v11_1/rkszones/{zoneId}/vendorSpecificAttributeProfiles

Use this API command to delete a list of vendor specific attribute profile.

Request
HideShow
Body
{
  "idList": [
    "6cdbf371-34c0-11e9-b3a3-268f6b038e32",
    "758b0101-34c0-11e9-b3a3-268f6b038e32"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

DNS Spoofing Profile

Retrieve DNS Spoofing Profile

GET/v11_1/rkszones/{zoneId}/dnsSpoofingProfiles/{id}

Use this API command to retrieve DNS Spoofing profile.

Response  200
HideShow
Body
{
  "id": "d5c37371-3e2c-11e9-bc88-76f54f595be0",
  "name": "spoofing1",
  "rules": [
    {
      "domainName": "d1",
      "ipList": [
        "1.1.1.1",
        "1.1.1.2",
        "1.1.1.3"
      ]
    },
    {
      "domainName": "d2",
      "ipList": [
        "1.1.1.1",
        "fe80::20c:29ff:fee7:4e6e"
      ]
    }
  ],
  "zoneId": "d5c37371-aaaa-11e9-bc88-76f54f595be0",
  "modifierUsername": "admin",
  "modifiedDateTime": 1551669789777,
  "creatorUsername": "admin",
  "createDateTime": 1551669789735
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "DNS Spoofing Profile's id",
      "type": "string"
    },
    "name": {
      "description": "DNS Spoofing Profile's name",
      "type": "string"
    },
    "description": {
      "description": "DNS Spoofing Profile's description",
      "type": "string"
    },
    "rules": {
      "description": "DNS Spoofing Profile's rules (At least one rule)",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "domainName": {
            "description": "Rule's Domain Name",
            "type": "string"
          },
          "ipList": {
            "description": "Rule's Ip addresses",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "domainName",
          "ipList"
        ]
      }
    },
    "zoneId": {
      "description": "The zone which DNS Spoofing Profile belong to",
      "type": "string"
    },
    "createDateTime": {
      "description": "The user who create the DNS Spoofing Profile",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "The time when the user modify the DNS Spoofing Profile",
      "type": "integer"
    },
    "creatorUsername": {
      "description": "The time when the user create the DNS Spoofing Profile",
      "type": "string"
    },
    "modifierUsername": {
      "description": "The user who modify the DNS Spoofing Profile",
      "type": "string"
    }
  }
}

Retrieve multiple DNS Spoofing Profile

GET/v11_1/rkszones/{zoneId}/dnsSpoofingProfiles

Use this API command to retrieve a list of DNS Spoofing profile.

Response  200
HideShow
Body
{
  "totalCount": 3,
  "hasMore": false,
  "firstIndex": 1,
  "list": [
    {
      "name": "spoofing1",
      "id": "d5c37371-3e2c-11e9-bc88-76f54f595be0"
    },
    {
      "name": "spoofing2",
      "id": "8828b080-3f12-11e9-b6bc-76f54f595be0"
    },
    {
      "name": "spoofing3",
      "id": "b11b13e1-3e48-11e9-bfc1-76f54f595be0"
    }
  ]
}
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": "DNS Spoofing Profile's id",
            "type": "string"
          },
          "name": {
            "description": "DNS Spoofing Profile's name",
            "type": "string"
          }
        }
      }
    }
  }
}

Create DNS Spoofing Profile

POST/v11_1/rkszones/{zoneId}/dnsSpoofingProfiles

Use this API command to create DNS Spoofing profile.

Request
HideShow
Body
{
  "name": "dnsSpoofingTest",
  "rules": [
    {
      "domainName": "d1",
      "ipList": [
        "1.1.1.1",
        "1.1.1.2",
        "1.1.1.3"
      ]
    },
    {
      "domainName": "d2",
      "ipList": [
        "1.1.1.1",
        "fe80::20c:29ff:fee7:4e6e"
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "DNS Spoofing Profile's name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "description": {
      "description": "DNS Spoofing Profile's description",
      "type": "string"
    },
    "rules": {
      "description": "DNS Spoofing Profile's rules (At least one rule)",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "domainName": {
            "description": "Rule's Domain Name",
            "type": "string"
          },
          "ipList": {
            "description": "Rule's Ip addresses",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "domainName",
          "ipList"
        ]
      }
    }
  },
  "required": [
    "name"
  ]
}
Response  200
HideShow
Body
{
  "id": "05f0503b-cfd9-414e-b37d-72a96f0f4288"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify DNS Spoofing Profile

PUT/v11_1/rkszones/{zoneId}/dnsSpoofingProfiles/{id}

Use this API command to update DNS Spoofing profile.

Request
HideShow
Body
{
  "name": "dnsSpoofingTest",
  "rules": [
    {
      "domainName": "d1",
      "ipList": [
        "1.1.1.1",
        "1.1.1.2",
        "1.1.1.3"
      ]
    },
    {
      "domainName": "d2",
      "ipList": [
        "1.1.1.1",
        "fe80::20c:29ff:fee7:4e6e"
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "DNS Spoofing Profile's name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "description": {
      "description": "DNS Spoofing Profile's description",
      "type": "string"
    },
    "rules": {
      "description": "DNS Spoofing Profile's rules (At least one rule)",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "domainName": {
            "description": "Rule's Domain Name",
            "type": "string"
          },
          "ipList": {
            "description": "Rule's Ip addresses",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "domainName",
          "ipList"
        ]
      }
    }
  },
  "required": [
    "name"
  ]
}
Response  204

Delete DNS Spoofing Profile

DELETE/v11_1/rkszones/{zoneId}/dnsSpoofingProfiles/{id}

Use this API command to delete DNS Spoofing profile.

Response  204

Delete multiple DNS Spoofing Profile

DELETE/v11_1/rkszones/dnsSpoofingProfiles

Use this API command to delete bulk DNS Spoofing profile.

Request
HideShow
Body
{
  "idList": [
    "eac50e51-4a63-11e7-a68a-0a0027000000",
    "1b4950d1-49d9-11e7-a68a-0a0027000000"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

VLAN Name Profile

Retrieve multiple VLAN Name Profile

GET/v11_1/rkszones/{zoneId}/vlanNameProfiles

Use this API command to retrieve a list of VLAN Name profile.

Response  200
HideShow
Body
{
  "totalCount": 4,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "vlanNameProfileId1",
      "name": "vlanname1"
    },
    {
      "id": "vlanNameProfileId2",
      "name": "vlanname2"
    },
    {
      "id": "vlanNameProfileId3",
      "name": "vlanname3"
    },
    {
      "id": "vlanNameProfileId4",
      "name": "vlanname4"
    }
  ]
}
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": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve VLAN Name Profile

GET/v11_1/rkszones/{zoneId}/vlanNameProfiles/{id}

Use this API command to retrieve VLAN Name profile.

Response  200
HideShow
Body
{
  "id": "vlanNameProfileId",
  "name": "vlanP3",
  "zoneId": "zoneId",
  "description": "vlanP3",
  "rules": [
    {
      "vlanName": "teacher",
      "vlanId": 2
    },
    {
      "vlanName": "student",
      "vlanId": 27
    }
  ],
  "creatorUsername": "admin",
  "createDateTime": 1583732315225,
  "modifierUsername": "admin",
  "modifiedDateTime": 0
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "rules": {
      "description": "The mapping rules of VLAN Name",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "vlanName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 247
          },
          "vlanId": {
            "type": "integer",
            "minimum": 1,
            "maximum": 4094
          }
        },
        "required": [
          "vlanName",
          "vlanId"
        ]
      }
    },
    "zoneId": {
      "type": "string"
    },
    "createDateTime": {
      "type": "integer"
    },
    "modifiedDateTime": {
      "type": "integer"
    },
    "creatorUsername": {
      "type": "string"
    },
    "modifierUsername": {
      "type": "string"
    }
  }
}

Create VLAN Nameg Profile

POST/v11_1/rkszones/{zoneId}/vlanNameProfiles

Use this API command to create VLAN Name profile.

Request
HideShow
Body
{
  "name": "profileName",
  "description": "profileNameDesc",
  "rules": [
    {
      "vlanName": "teacher",
      "vlanId": 2
    },
    {
      "vlanName": "student",
      "vlanId": 27
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "type": "string"
    },
    "rules": {
      "description": "The mapping rules of VLAN Name",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "vlanName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 247
          },
          "vlanId": {
            "type": "integer",
            "minimum": 1,
            "maximum": 4094
          }
        },
        "required": [
          "vlanName",
          "vlanId"
        ]
      }
    }
  },
  "required": [
    "name",
    "rules"
  ]
}
Response  200
HideShow
Body
{
  "id": "05f0503b-cfd9-414e-b37d-72a96f0f4288"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify VLAN Name Profile

PUT/v11_1/rkszones/{zoneId}/vlanNameProfiles/{id}

Use this API command to update VLAN Name profile.

Request
HideShow
Body
{
  "name": "profileName",
  "description": "profileNameDesc",
  "rules": [
    {
      "vlanName": "teacher",
      "vlanId": 2
    },
    {
      "vlanName": "student",
      "vlanId": 27
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "type": "string"
    },
    "rules": {
      "description": "The mapping rules of VLAN Name",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "vlanName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 247
          },
          "vlanId": {
            "type": "integer",
            "minimum": 1,
            "maximum": 4094
          }
        },
        "required": [
          "vlanName",
          "vlanId"
        ]
      }
    }
  },
  "required": [
    "name",
    "rules"
  ]
}
Response  204

Delete VLAN Name Profile

DELETE/v11_1/rkszones/{zoneId}/vlanNameProfiles/{id}

Use this API command to delete VLAN Name profile.

Response  204

Delete multiple VLAN Name Profile

DELETE/v11_1/rkszones/vlanNameProfiles

Use this API command to delete bulk VLAN Name profile.

Request
HideShow
Body
{
  "idList": [
    "eac50e51-4a63-11e7-a68a-0a0027000000",
    "1b4950d1-49d9-11e7-a68a-0a0027000000"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Social Media Login Profile

Retrieve multiple Social Media Login profiles

GET/v11_1/rkszones/{zoneId}/socialMediaLoginProfiles

Use this API command to retrieve a list of Social Media Login profile.

Response  200
HideShow
Body
{
  "totalCount": 4,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "socialMediaLoginProfile1",
      "name": "socialMediaLogin1",
      "description": "socialMediaLogin1 - description",
      "linkedinEnabled": false,
      "linkedinClientId": "",
      "linkedinSecret": "",
      "googleEnabled": true,
      "googleClientId": "zkdjidojjwpdojpqoejpdfojpjhfhjpidaidj",
      "googleSecret": "zjvheyu",
      "microsoftEnabled": false,
      "microsoftClientId": "",
      "microsoftSecret": "",
      "facebookEnabled": false,
      "facebookClientId": "1234564897521312231",
      "facebookSecret": "WdkjmicvGihfhjovk2",
      "whitelistedDomains": [
        {
          "domain": "www.google.com"
        }
      ]
    },
    {
      "id": "socialMediaLoginProfile2",
      "name": "socialMediaLogin2",
      "description": "socialMediaLogin2 - description",
      "linkedinEnabled": false,
      "linkedinClientId": "",
      "linkedinSecret": "",
      "googleEnabled": true,
      "googleClientId": "zkdjidojjwpdojpqoejpdfojpjhfhjpidaidj",
      "googleSecret": "zjvheyu",
      "microsoftEnabled": false,
      "microsoftClientId": "",
      "microsoftSecret": "",
      "facebookEnabled": false,
      "facebookClientId": "1234564897521312231",
      "facebookSecret": "WdkjmicvGihfhjovk2",
      "whitelistedDomains": [
        {
          "domain": "fstatic-a.akamaihd.net"
        },
        {
          "domain": "auth.gfx.ms"
        }
      ]
    },
    {
      "id": "socialMediaLoginProfile3",
      "name": "socialMediaLogin3",
      "description": "socialMediaLogin3 - description",
      "linkedinEnabled": false,
      "linkedinClientId": "",
      "linkedinSecret": "",
      "googleEnabled": true,
      "googleClientId": "zkdjidojjwpdojpqoejpdfojpjhfhjpidaidj",
      "googleSecret": "zjvheyu",
      "microsoftEnabled": false,
      "microsoftClientId": "",
      "microsoftSecret": "",
      "facebookEnabled": false,
      "facebookClientId": "1234564897521312231",
      "facebookSecret": "WdkjmicvGihfhjovk2",
      "whitelistedDomains": [
        {
          "domain": "www.google.com"
        },
        {
          "domain": "*.apple.com"
        }
      ]
    },
    {
      "id": "socialMediaLoginProfile4",
      "name": "socialMediaLogin4",
      "description": "socialMediaLogin4 - description",
      "linkedinEnabled": false,
      "linkedinClientId": "",
      "linkedinSecret": "",
      "googleEnabled": true,
      "googleClientId": "zkdjidojjwpdojpqoejpdfojpjhfhjpidaidj",
      "googleSecret": "zjvheyu",
      "microsoftEnabled": false,
      "microsoftClientId": "",
      "microsoftSecret": "",
      "facebookEnabled": false,
      "facebookClientId": "1234564897521312231",
      "facebookSecret": "WdkjmicvGihfhjovk2",
      "whitelistedDomains": [
        {
          "domain": "fstatic-a.akamaihd.net "
        },
        {
          "domain": "*.geotrust.com"
        }
      ]
    }
  ]
}
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": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "linkedinEnabled": {
            "type": "boolean"
          },
          "linkedinClientId": {
            "type": "string"
          },
          "linkedinSecret": {
            "type": "string"
          },
          "googleEnabled": {
            "type": "boolean"
          },
          "googleClientId": {
            "type": "string"
          },
          "googleSecret": {
            "type": "string"
          },
          "microsoftEnabled": {
            "type": "boolean"
          },
          "microsoftClientId": {
            "type": "string"
          },
          "microsoftSecret": {
            "type": "string"
          },
          "facebookEnabled": {
            "type": "boolean"
          },
          "facebookClientId": {
            "type": "string"
          },
          "facebookSecret": {
            "type": "string"
          },
          "whitelistedDomains": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "domain": {
                  "type": "string"
                }
              },
              "required": [
                "domain"
              ]
            }
          }
        }
      }
    }
  }
}

Retrieve the specific Social Media Login profile

GET/v11_1/rkszones/{zoneId}/socialMediaLoginProfiles/{id}

Use this API command to retrieve the specific Social Media Login profile.

Response  200
HideShow
Body
{
  "id": "socialMediaLoginProfileId",
  "name": "socialMediaLogin1",
  "zoneId": "zoneId",
  "description": "socialMediaLogin1 - description",
  "linkedinEnabled": false,
  "linkedinClientId": "",
  "linkedinSecret": "",
  "googleEnabled": true,
  "googleClientId": "zkdjidojjwpdojpqoejpdfojpjhfhjpidaidj",
  "googleSecret": "zjvheyu",
  "microsoftEnabled": false,
  "microsoftClientId": "",
  "microsoftSecret": "",
  "facebookEnabled": false,
  "facebookClientId": "1234564897521312231",
  "facebookSecret": "WdkjmicvGihfhjovk2",
  "whitelistedDomains": [
    {
      "domain": "www.google.com"
    },
    {
      "domain": "auth.gfx.ms"
    },
    {
      "domain": "*.gstatic.com"
    },
    {
      "domain": "*.facebook.com"
    },
    {
      "domain": "fstatic-a.akamaihd.net"
    },
    {
      "domain": "*.apple.com"
    }
  ],
  "creatorUsername": "admin",
  "createDateTime": 1583732315225,
  "modifierUsername": "admin",
  "modifiedDateTime": 1583992315225
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "linkedinEnabled": {
      "type": "boolean"
    },
    "linkedinClientId": {
      "type": "string"
    },
    "linkedinSecret": {
      "type": "string"
    },
    "googleEnabled": {
      "type": "boolean"
    },
    "googleClientId": {
      "type": "string"
    },
    "googleSecret": {
      "type": "string"
    },
    "microsoftEnabled": {
      "type": "boolean"
    },
    "microsoftClientId": {
      "type": "string"
    },
    "microsoftSecret": {
      "type": "string"
    },
    "facebookEnabled": {
      "type": "boolean"
    },
    "facebookClientId": {
      "type": "string"
    },
    "facebookSecret": {
      "type": "string"
    },
    "whitelistedDomains": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "domain": {
            "type": "string"
          }
        },
        "required": [
          "domain"
        ]
      }
    },
    "zoneId": {
      "type": "string"
    },
    "createDateTime": {
      "type": "integer"
    },
    "modifiedDateTime": {
      "type": "integer"
    },
    "creatorUsername": {
      "type": "string"
    },
    "modifierUsername": {
      "type": "string"
    }
  }
}

Create a new Social Media Login Profile

POST/v11_1/rkszones/{zoneId}/socialMediaLoginProfiles

Use this API command to create a new Social Media Login profile.

Request
HideShow
Body
{
  "name": "profileName",
  "description": "socialMediaLogin1 - description",
  "linkedinEnabled": false,
  "linkedinClientId": "",
  "linkedinSecret": "",
  "googleEnabled": true,
  "googleClientId": "zkdjidojjwpdojpqoejpdfojpjhfhjpidaidj",
  "googleSecret": "zjvheyu",
  "microsoftEnabled": false,
  "microsoftClientId": "",
  "microsoftSecret": "",
  "facebookEnabled": false,
  "facebookClientId": "1234564897521312231",
  "facebookSecret": "WdkjmicvGihfhjovk2",
  "whitelistedDomains": [
    {
      "domain": "www.google.com"
    },
    {
      "domain": "*.apple.com"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "type": "string"
    },
    "linkedinEnabled": {
      "type": "boolean"
    },
    "linkedinClientId": {
      "type": "string"
    },
    "linkedinSecret": {
      "type": "string"
    },
    "googleEnabled": {
      "type": "boolean"
    },
    "googleClientId": {
      "type": "string"
    },
    "googleSecret": {
      "type": "string"
    },
    "microsoftEnabled": {
      "type": "boolean"
    },
    "microsoftClientId": {
      "type": "string"
    },
    "microsoftSecret": {
      "type": "string"
    },
    "facebookEnabled": {
      "type": "boolean"
    },
    "facebookClientId": {
      "type": "string"
    },
    "facebookSecret": {
      "type": "string"
    },
    "whitelistedDomains": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "domain": {
            "type": "string"
          }
        },
        "required": [
          "domain"
        ]
      }
    }
  },
  "required": [
    "name",
    "whitelistedDomains"
  ]
}
Response  200
HideShow
Body
{
  "id": "05f0503b-cfd9-414e-b37d-72a96f0f4288"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify the specific Social Media Login profile

PUT/v11_1/rkszones/{zoneId}/socialMediaLoginProfiles/{id}

Use this API command to update the specific Social Media Login profile.

Request
HideShow
Body
{
  "name": "profileName",
  "description": "socialMediaLogin1 - description",
  "linkedinEnabled": false,
  "linkedinClientId": "",
  "linkedinSecret": "",
  "googleEnabled": true,
  "googleClientId": "zkdjidojjwpdojpqoejpdfojpjhfhjpidaidj",
  "googleSecret": "zjvheyu",
  "microsoftEnabled": false,
  "microsoftClientId": "",
  "microsoftSecret": "",
  "facebookEnabled": false,
  "facebookClientId": "1234564897521312231",
  "facebookSecret": "WdkjmicvGihfhjovk2",
  "whitelistedDomains": [
    {
      "domain": "www.google.com"
    },
    {
      "domain": "*.apple.com"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "type": "string"
    },
    "linkedinEnabled": {
      "type": "boolean"
    },
    "linkedinClientId": {
      "type": "string"
    },
    "linkedinSecret": {
      "type": "string"
    },
    "googleEnabled": {
      "type": "boolean"
    },
    "googleClientId": {
      "type": "string"
    },
    "googleSecret": {
      "type": "string"
    },
    "microsoftEnabled": {
      "type": "boolean"
    },
    "microsoftClientId": {
      "type": "string"
    },
    "microsoftSecret": {
      "type": "string"
    },
    "facebookEnabled": {
      "type": "boolean"
    },
    "facebookClientId": {
      "type": "string"
    },
    "facebookSecret": {
      "type": "string"
    },
    "whitelistedDomains": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "domain": {
            "type": "string"
          }
        },
        "required": [
          "domain"
        ]
      }
    }
  },
  "required": [
    "name",
    "whitelistedDomains"
  ]
}
Response  204

Delete the specific Social Media Login profile

DELETE/v11_1/rkszones/{zoneId}/socialMediaLoginProfiles/{id}

Use this API command to delete the specific Social Media Login profile.

Response  204

Delete multiple Social Media Login profiles

DELETE/v11_1/rkszones/socialMediaLoginProfiles

Use this API command to delete bulk Social Media Login profiles.

Request
HideShow
Body
{
  "idList": [
    "eac50e51-4a63-11e7-a68a-0a0027000000",
    "1b4950d1-49d9-11e7-a68a-0a0027000000"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

AP External Syslog Server Profile

Retrieve List

GET/v11_1/apSyslogServerProfiles

Use this API command to retrieve AP Syslog Server Profile list.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

domainId
string (required) 
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "0337caf5-3737-4e83-b5f9-03817d54d784",
      "name": "TES31"
    },
    {
      "id": "7f980546-f7f2-4ef5-9ba3-c81f4bc95e4a",
      "name": "TES3"
    }
  ]
}
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": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    }
  }
}

Get Ap Syslog Server Profile

GET/v11_1/apSyslogServerProfiles/{id}

Get Ap Syslog Server Profile

Response  200
HideShow
Body
{}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "domainId": {
      "type": "string"
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "primaryAddress": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "primaryPort": {
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "primaryProtocol": {
      "type": "string",
      "enum": [
        "IPPROTO_TCP",
        "IPPROTO_UDP"
      ]
    },
    "secondaryAddress": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "secondaryPort": {
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "secondaryProtocol": {
      "type": "string",
      "enum": [
        "IPPROTO_TCP",
        "IPPROTO_UDP"
      ],
      "default": "IPPROTO_TCP"
    },
    "redundancyMode": {
      "type": "string",
      "enum": [
        "ACTIVE_ACTIVE",
        "PRIMARY_BACKUP"
      ],
      "default": "ACTIVE_ACTIVE"
    },
    "flowLevel": {
      "type": "string",
      "enum": [
        "GENERAL_LOGS",
        "CLIENT_FLOW",
        "ALL_LOGS"
      ],
      "default": "GENERAL_LOGS"
    },
    "facility": {
      "type": "string",
      "enum": [
        "KEEP_ORIGINAL",
        "LOCAL0",
        "LOCAL1",
        "LOCAL2",
        "LOCAL3",
        "LOCAL4",
        "LOCAL5",
        "LOCAL6",
        "LOCAL7"
      ],
      "default": "KEEP_ORIGINAL"
    },
    "priority": {
      "type": "string",
      "enum": [
        "EMERGENCY",
        "ALERT",
        "CRITICAL",
        "ERROR",
        "WARNING",
        "NOTICE",
        "INFO",
        "ALL"
      ],
      "default": "ERROR"
    },
    "createDateTime": {
      "type": "integer"
    },
    "modifiedDateTime": {
      "type": "integer"
    },
    "creatorUsername": {
      "type": "string"
    },
    "modifierUsername": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "primaryAddress"
  ]
}

Create Ap Syslog Server Profile

POST/v11_1/apSyslogServerProfiles

Create Ap Syslog Server Profile

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "type": "string"
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "primaryAddress": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "primaryPort": {
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "primaryProtocol": {
      "type": "string",
      "enum": [
        "IPPROTO_TCP",
        "IPPROTO_UDP"
      ]
    },
    "secondaryAddress": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "secondaryPort": {
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "secondaryProtocol": {
      "type": "string",
      "enum": [
        "IPPROTO_TCP",
        "IPPROTO_UDP"
      ],
      "default": "IPPROTO_TCP"
    },
    "redundancyMode": {
      "type": "string",
      "enum": [
        "ACTIVE_ACTIVE",
        "PRIMARY_BACKUP"
      ],
      "default": "ACTIVE_ACTIVE"
    },
    "flowLevel": {
      "type": "string",
      "enum": [
        "GENERAL_LOGS",
        "CLIENT_FLOW",
        "ALL_LOGS"
      ],
      "default": "GENERAL_LOGS"
    },
    "facility": {
      "type": "string",
      "enum": [
        "KEEP_ORIGINAL",
        "LOCAL0",
        "LOCAL1",
        "LOCAL2",
        "LOCAL3",
        "LOCAL4",
        "LOCAL5",
        "LOCAL6",
        "LOCAL7"
      ],
      "default": "KEEP_ORIGINAL"
    },
    "priority": {
      "type": "string",
      "enum": [
        "EMERGENCY",
        "ALERT",
        "CRITICAL",
        "ERROR",
        "WARNING",
        "NOTICE",
        "INFO",
        "ALL"
      ],
      "default": "ERROR"
    }
  },
  "required": [
    "domainId",
    "name",
    "primaryAddress"
  ]
}
Response  200
HideShow
Body
{
  "id": "05f0503b-cfd9-414e-b37d-72a96f0f4288"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Update Ap Syslog Server Profile

PUT/v11_1/apSyslogServerProfiles/{id}

Update Ap Syslog Server Profile

Request
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "primaryAddress": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "primaryPort": {
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "primaryProtocol": {
      "type": "string",
      "enum": [
        "IPPROTO_TCP",
        "IPPROTO_UDP"
      ]
    },
    "secondaryAddress": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "secondaryPort": {
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "secondaryProtocol": {
      "type": "string",
      "enum": [
        "IPPROTO_TCP",
        "IPPROTO_UDP"
      ]
    },
    "redundancyMode": {
      "type": "string",
      "enum": [
        "ACTIVE_ACTIVE",
        "PRIMARY_BACKUP"
      ]
    },
    "flowLevel": {
      "type": "string",
      "enum": [
        "GENERAL_LOGS",
        "CLIENT_FLOW",
        "ALL_LOGS"
      ]
    },
    "facility": {
      "type": "string",
      "enum": [
        "KEEP_ORIGINAL",
        "LOCAL0",
        "LOCAL1",
        "LOCAL2",
        "LOCAL3",
        "LOCAL4",
        "LOCAL5",
        "LOCAL6",
        "LOCAL7"
      ]
    },
    "priority": {
      "type": "string",
      "enum": [
        "EMERGENCY",
        "ALERT",
        "CRITICAL",
        "ERROR",
        "WARNING",
        "NOTICE",
        "INFO",
        "ALL"
      ]
    }
  },
  "required": [
    "name",
    "primaryAddress"
  ]
}
Response  204

Bulk delete Ap Syslog Server Profile

DELETE/v11_1/apSyslogServerProfiles

Bulk delete Ap Syslog Server Profile

Request
HideShow
Body
{
  "idList": [
    "eac50e51-4a63-11e7-a68a-0a0027000000",
    "1b4950d1-49d9-11e7-a68a-0a0027000000"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Delete Ap Syslog Server Profile

DELETE/v11_1/apSyslogServerProfiles/{id}

Delete Ap Syslog Server Profile

Response  200

AP SNMP Agent Profile

Retrieve

GET/v11_1/apSnmpAgentProfiles/{id}

Use this API command to retrieve AP SNMP Agent Profile by profile’s ID.

Response  200
HideShow
Body
{
  "id": "d4b408f1-e4ea-47ac-8d5a-90a87f4a313d",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "qqqq",
  "description": "",
  "snmpV2Agent": null,
  "snmpV3Agent": null,
  "creatorUsername": "admin",
  "createDateTime": 1626359162109,
  "modifierUsername": "admin",
  "modifiedDateTime": 0
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "snmpV2Agent": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "communityName": {
            "type": "string"
          },
          "readEnabled": {
            "type": "boolean"
          },
          "writeEnabled": {
            "type": "boolean"
          },
          "notificationEnabled": {
            "type": "boolean"
          },
          "notificationType": {
            "type": "string",
            "enum": [
              "TRAP",
              "INFORM"
            ]
          },
          "notificationTarget": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "address": {
                  "type": "string"
                },
                "port": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                }
              },
              "required": [
                "address",
                "port"
              ]
            }
          }
        },
        "required": [
          "communityName",
          "readEnabled",
          "writeEnabled",
          "notificationEnabled"
        ]
      }
    },
    "snmpV3Agent": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "userName": {
            "type": "string"
          },
          "authProtocol": {
            "type": "string",
            "enum": [
              "MD5",
              "SHA"
            ]
          },
          "authPassword": {
            "type": "string",
            "minLength": 8
          },
          "privProtocol": {
            "type": "string",
            "enum": [
              "NONE",
              "DES",
              "AES"
            ]
          },
          "privPassword": {
            "type": "string",
            "minLength": 8
          },
          "readEnabled": {
            "type": "boolean"
          },
          "writeEnabled": {
            "type": "boolean"
          },
          "notificationEnabled": {
            "type": "boolean"
          },
          "notificationType": {
            "type": "string",
            "enum": [
              "TRAP",
              "INFORM"
            ]
          },
          "notificationTarget": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "address": {
                  "type": "string"
                },
                "port": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                }
              },
              "required": [
                "address",
                "port"
              ]
            }
          }
        },
        "required": [
          "userName",
          "authProtocol",
          "authPassword",
          "privProtocol",
          "readEnabled",
          "writeEnabled",
          "notificationEnabled"
        ]
      }
    }
  }
}

Retrieve List

GET/v11_1/apSnmpAgentProfiles

Use this API command to retrieve AP SNMP Agent Profile list.

URI Parameters
HideShow
index
string (optional) 

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

listSize
string (optional) 

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

domainId
string (required) 
Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "d4b408f1-e4ea-47ac-8d5a-90a87f4a313d",
      "name": "MyProfile"
    }
  ]
}
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": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    }
  }
}

Create

POST/v11_1/apSnmpAgentProfiles

Use this API command to create a new AP SNMP Agent Profile.

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "MySNMPAgentProfile",
  "description": "test",
  "snmpV2Agent": [
    {
      "communityName": "snmpv2",
      "notificationEnabled": false,
      "notificationTarget": [],
      "notificationType": "TRAP",
      "readEnabled": false,
      "writeEnabled": false
    }
  ],
  "snmpV3Agent": [
    {
      "userName": "myuser",
      "authProtocol": "SHA",
      "authPassword": "authpass",
      "privProtocol": "DES",
      "privPassword": "privatepass",
      "notificationEnabled": false,
      "notificationTarget": [],
      "readEnabled": true,
      "writeEnabled": false
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "domainId": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "snmpV2Agent": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "communityName": {
            "type": "string"
          },
          "readEnabled": {
            "type": "boolean"
          },
          "writeEnabled": {
            "type": "boolean"
          },
          "notificationEnabled": {
            "type": "boolean"
          },
          "notificationType": {
            "type": "string",
            "enum": [
              "TRAP",
              "INFORM"
            ]
          },
          "notificationTarget": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "address": {
                  "type": "string"
                },
                "port": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                }
              },
              "required": [
                "address",
                "port"
              ]
            }
          }
        },
        "required": [
          "communityName",
          "readEnabled",
          "writeEnabled",
          "notificationEnabled"
        ]
      }
    },
    "snmpV3Agent": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "userName": {
            "type": "string"
          },
          "authProtocol": {
            "type": "string",
            "enum": [
              "MD5",
              "SHA"
            ]
          },
          "authPassword": {
            "type": "string",
            "minLength": 8
          },
          "privProtocol": {
            "type": "string",
            "enum": [
              "NONE",
              "DES",
              "AES"
            ]
          },
          "privPassword": {
            "type": "string",
            "minLength": 8
          },
          "readEnabled": {
            "type": "boolean"
          },
          "writeEnabled": {
            "type": "boolean"
          },
          "notificationEnabled": {
            "type": "boolean"
          },
          "notificationType": {
            "type": "string",
            "enum": [
              "TRAP",
              "INFORM"
            ]
          },
          "notificationTarget": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "address": {
                  "type": "string"
                },
                "port": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                }
              },
              "required": [
                "address",
                "port"
              ]
            }
          }
        },
        "required": [
          "userName",
          "authProtocol",
          "authPassword",
          "privProtocol",
          "readEnabled",
          "writeEnabled",
          "notificationEnabled"
        ]
      }
    }
  },
  "required": [
    "domainId",
    "name"
  ]
}
Response  200
HideShow
Body
{
  "id": "05f0503b-cfd9-414e-b37d-72a96f0f4288"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PUT/v11_1/apSnmpAgentProfiles/{id}

Use this API command to modify AP SNMP Agent Profile by profile’s ID.

Request
HideShow
Body
{
  "name": "MySNMPAgentProfile",
  "description": "test",
  "snmpV2Agent": [
    {
      "communityName": "snmpv2",
      "readEnabled": false,
      "writeEnabled": false,
      "notificationEnabled": false
    }
  ],
  "snmpV3Agent": [
    {
      "userName": "myuser",
      "authProtocol": "SHA",
      "authPassword": "authpass",
      "privProtocol": "DES",
      "privPassword": "privatepass",
      "readEnabled": true,
      "writeEnabled": false,
      "notificationEnabled": false
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "snmpV2Agent": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "communityName": {
            "type": "string"
          },
          "readEnabled": {
            "type": "boolean"
          },
          "writeEnabled": {
            "type": "boolean"
          },
          "notificationEnabled": {
            "type": "boolean"
          },
          "notificationType": {
            "type": "string",
            "enum": [
              "TRAP",
              "INFORM"
            ]
          },
          "notificationTarget": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "address": {
                  "type": "string"
                },
                "port": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                }
              },
              "required": [
                "address",
                "port"
              ]
            }
          }
        },
        "required": [
          "communityName",
          "readEnabled",
          "writeEnabled",
          "notificationEnabled"
        ]
      }
    },
    "snmpV3Agent": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "userName": {
            "type": "string"
          },
          "authProtocol": {
            "type": "string",
            "enum": [
              "MD5",
              "SHA"
            ]
          },
          "authPassword": {
            "type": "string",
            "minLength": 8
          },
          "privProtocol": {
            "type": "string",
            "enum": [
              "NONE",
              "DES",
              "AES"
            ]
          },
          "privPassword": {
            "type": "string",
            "minLength": 8
          },
          "readEnabled": {
            "type": "boolean"
          },
          "writeEnabled": {
            "type": "boolean"
          },
          "notificationEnabled": {
            "type": "boolean"
          },
          "notificationType": {
            "type": "string",
            "enum": [
              "TRAP",
              "INFORM"
            ]
          },
          "notificationTarget": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "address": {
                  "type": "string"
                },
                "port": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                }
              },
              "required": [
                "address",
                "port"
              ]
            }
          }
        },
        "required": [
          "userName",
          "authProtocol",
          "authPassword",
          "privProtocol",
          "readEnabled",
          "writeEnabled",
          "notificationEnabled"
        ]
      }
    }
  },
  "required": [
    "name"
  ]
}
Response  204

Bulk Delete

DELETE/v11_1/apSnmpAgentProfiles

Use this API command to bulk delete AP SNMP Agent Profile.

Request
HideShow
Body
{
  "idList": [
    "eac50e51-4a63-11e7-a68a-0a0027000000",
    "1b4950d1-49d9-11e7-a68a-0a0027000000"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  204

Delete

DELETE/v11_1/apSnmpAgentProfiles/{id}

Use this API command to delete AP SNMP Agent Profile by profile’s ID.

Response  204

Data Plane

DP Network

  • Retrieve List

GET/v11_1/enterprise/planes

Use this API command to retrieve a list of data planes.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "clusterNode": "JSZML-289",
      "description": "api test",
      "model": "SZ104",
      "serialNumber": "00004567",
      "numOfAPs": 0,
      "macAddress": "00:00:0C:43:24:00",
      "mntCtrlIp": "10.2.9.174",
      "apTunnelIp": "172.17.60.86",
      "dpStatus": "Managed",
      "clusterRole": "Leader",
      "uptime": "1.0d 20.0h 28.0m ",
      "type": "External - V"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of data plane",
            "type": "string"
          },
          "model": {
            "description": "Model",
            "type": "string"
          },
          "serialNumber": {
            "description": "Serial Number",
            "type": "string"
          },
          "dpStatus": {
            "description": "Status",
            "type": "string"
          },
          "uptime": {
            "description": "Uptime",
            "type": "string"
          },
          "type": {
            "description": "Type",
            "type": "string"
          },
          "apTunnelIp": {
            "type": "string"
          },
          "clusterNode": {
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "clusterRole": {
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "macAddress": {
            "type": "string"
          },
          "mntCtrlIp": {
            "type": "string"
          },
          "numOfAPs": {
            "type": "integer"
          }
        }
      }
    }
  }
}

  • Retrieve

GET/v11_1/enterprise/planes/{bladeUUID}

Use this API command to retrieve data plane by bladeUUID.

Response  200
HideShow
Body
{
  "isDataCenter": false,
  "interfaceMode": "SINGLE",
  "primaryInterface": {
    "ipMode": "STATIC",
    "ipAddress": "192.168.1.0",
    "subnetMask": "255.255.255.0",
    "gateway": "192.168.1.0",
    "primaryDNSServer": "2.2.2.2",
    "secondaryDNSServer": "5.5.5.5",
    "vlan": "",
    "natIp": ""
  },
  "ipv6PrimaryInterface": {
    "ipMode": "STATIC",
    "ipAddress": "2222:3333::5555/64",
    "gateway": "2222:3333::0000",
    "primaryDNSServer": "2222:3333::5555",
    "secondaryDNSServer": "2222:3333::2222"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apTunnelData": {
      "additionalProperties": false,
      "properties": {
        "gateway": {
          "description": "Gateway",
          "type": "string"
        },
        "ipAddress": {
          "description": "IP address",
          "type": "string"
        },
        "ipMode": {
          "description": "IP mode",
          "type": "string",
          "enum": [
            "STATIC",
            "DHCP"
          ]
        },
        "natIp": {
          "description": "Data NAT IP",
          "type": "string"
        },
        "subnetMask": {
          "description": "Subnet Mask",
          "type": "string"
        }
      },
      "type": "object"
    },
    "dnsServer": {
      "additionalProperties": false,
      "properties": {
        "primaryDNSServer": {
          "description": "Primary DNS Server",
          "type": "string"
        },
        "secondaryDNSServer": {
          "description": "Secondary DNS Server",
          "type": "string"
        }
      },
      "type": "object"
    },
    "managementAPControl": {
      "additionalProperties": false,
      "properties": {
        "gateway": {
          "description": "Gateway",
          "type": "string"
        },
        "ipAddress": {
          "description": "IP address",
          "type": "string"
        },
        "ipMode": {
          "description": "IP mode",
          "type": "string",
          "enum": [
            "STATIC",
            "DHCP"
          ]
        },
        "natIp": {
          "description": "Control NAT IP",
          "type": "string"
        },
        "subnetMask": {
          "description": "Subnet mask",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}

  • Modify

PATCH/v11_1/enterprise/planes/{bladeUUID}

Use this API command to modify data plane. It may take 5 to 10 minutes to restart the network and controller services.

Request
HideShow
Body
{
  "isDataCenter": false,
  "interfaceMode": "SINGLE",
  "primaryInterface": {
    "ipMode": "STATIC",
    "ipAddress": "192.168.1.0",
    "subnetMask": "255.255.255.0",
    "gateway": "192.168.1.0",
    "primaryDNSServer": "2.2.2.2",
    "secondaryDNSServer": "5.5.5.5",
    "vlan": "",
    "natIp": ""
  },
  "ipv6PrimaryInterface": {
    "ipMode": "STATIC",
    "ipAddress": "2222:3333::5555/64",
    "gateway": "2222:3333::0000",
    "primaryDNSServer": "2222:3333::5555",
    "secondaryDNSServer": "2222:3333::2222"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apTunnelData": {
      "additionalProperties": false,
      "properties": {
        "gateway": {
          "description": "Gateway",
          "type": "string"
        },
        "ipAddress": {
          "description": "IP address",
          "type": "string"
        },
        "ipMode": {
          "description": "IP mode",
          "type": "string",
          "enum": [
            "STATIC",
            "DHCP"
          ]
        },
        "natIp": {
          "description": "Data NAT IP",
          "type": "string"
        },
        "subnetMask": {
          "description": "Subnet Mask",
          "type": "string"
        }
      },
      "type": "object"
    },
    "dnsServer": {
      "additionalProperties": false,
      "properties": {
        "primaryDNSServer": {
          "description": "Primary DNS Server",
          "type": "string"
        },
        "secondaryDNSServer": {
          "description": "Secondary DNS Server",
          "type": "string"
        }
      },
      "type": "object"
    },
    "managementAPControl": {
      "additionalProperties": false,
      "properties": {
        "gateway": {
          "description": "Gateway",
          "type": "string"
        },
        "ipAddress": {
          "description": "IP address",
          "type": "string"
        },
        "ipMode": {
          "description": "IP mode",
          "type": "string",
          "enum": [
            "STATIC",
            "DHCP"
          ]
        },
        "natIp": {
          "description": "Control NAT IP",
          "type": "string"
        },
        "subnetMask": {
          "description": "Subnet mask",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}
Response  204

Multicast Forwarding

  • Get Multicast Forwarding global setting

GET/v11_1/planes/multicastForwarding/setting

Use this API command to get Multicast Forwarding global setting

Response  200
HideShow
Body
{
  "enabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ]
}

  • Set Multicast Forwarding global setting

PATCH/v11_1/planes/multicastForwarding/setting

Use this API command to set Multicast Forwarding global setting

Request
HideShow
Body
{
  "enabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ]
}
Response  200

Data Plane Operational

  • Switchover DP

POST/v11_1/dps/switchoverCluster

Use this API command to switchover DP to another cluster

Request
HideShow
Body
{
  "ipOrFqdn": "172.18.11.11",
  "dpIdList": [
    "97U8994REGV2UHT0V4SVP8RXLDT123640055DA2252540035EEAD"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ipOrFqdn": {
      "description": "IP or FQDN address of destination cluster, Notice: System will take ipOrFqdn as 1st priority, and clusterName as 2nd.",
      "type": "string"
    },
    "clusterName": {
      "description": "Name of destination cluster, Notice: System will take ipOrFqdn as 1st priority, and clusterName as 2nd.",
      "type": "string"
    },
    "dpIdList": {
      "description": "DP ID list",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "deleteRecord": {
      "description": "Flag to delete DP record after switchover cluster. Default value is false.",
      "type": "boolean"
    }
  }
}
Response  204

Generated by aglio on 18 Nov 2022