Unleashed Multi-Site Manager

Public API Reference Guide

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Contents

Overview.. 3

Version Matrix. 4

Terminology. 4

Limitation. 5

URIs. 5

GET /v1_0/domains/{id}.. 5

GET /v1_0/aps/.. 6

GET /v1_0/rkszones/.. 9

GET /v1_0/rkszones/{id}.. 11

GET /v1_0/rkszones/sn/{sn}.. 14

GET /v1_0/rkszones/{id}/mesh.. 18

GET /v1_0/rkszones/{zoneId}/wlans.. 21

PUT /v1_0/rkszones/{zoneId}/wlans.. 23

PATCH /v1_0/rkszones/wlans/state.. 24

GET /v1_0/clients/byZone/{id}. 25

POST /v1_0/alert/alarm/list.. 27

POST /v1_0/alert/event/list.. 30

POST /v1_0/switch/.. 33

GET /v1_0/switch/{id}.. 36

POST /v1_0/switch/clients.. 38

POST /v1_0/switch/alarms. 41

POST /v1_0/switch/events. 45

POST /v1_0/switch/ports/details.. 49

 

 

 

 

 

 

 

 

Overview

The UMM RESTful APIs provide access to certain UMM managed resources, so that 3rd-party clients can pull information or change resource state by mean of RESTful operations.

Host: UMM server.

Resource: Uniform Resource Identifier (URI) provides a way for external client to get access to resource. All API URIs in this guide should use common prefix as

Prefix Pattern

Note

https://{host}(:{port})/intune/api/public

 

Operation: The API defines CRUD operation on the resources.

 

Security and HTTP Headers: The RESTful API is protected by Security Code defined in UMM. Security Code can be found in UMM WEB UI ‘System’ -> ‘System Settings’ -> ‘Security Code’ by super admin only. Customers can click button ‘reset’ to regenerate a ticket. In this way, following parameters is required in the HTTP headers of all API requests:

Parameter

Value

Content-Type

“application/json;charset=UTF-8”

serviceTicket

{serviceTicket}

 

Response: The response information will be represented, denoted in JSON format, and pass back to the client through HTTP. The general response format is defined as the following:

·         Successful operation without data returned

       HTTP Response Status 204 with empty response body
HTTP response status code 200 with JSON encoded data in the response body 
HTTP response status code 200 with JSON encoded list data in the response body
{"totalCount": 100, "hasMore": false, “firstIndex”: 1, “list”: {{…}, {…}} 

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

101

Bad HTTP request

102

Bad HTTP response

 

Version Matrix

 

UMM Version

API Version

2.3

v1_0

 

Terminology

To align with Ruckus product line, UMM uses the same terminology with SZ in Public API parameters.  Here is a mapping of terminology between public API and UI.

UMM UI

PUBLIC API Parameters

Group

Domain

Unleashed Network/ZoneDirector

Zone

 

 

Limitation

·         Group field in a filter which is defined as an array doesn’t support multiple elements due to UMM group rule is different with SZ. Only the last element is processed. 

 

URIs

GET /v1_0/domains/{id}

Retrieve group information by specified id. When id is 0, UMM will response all groups information.

URI Parameters

Recursively: 1(response a tree, default);0(response a list) (optional)

Response  200

Body
{
  "id": "1",
  "name": "test_1",
  "domainType": "Wireless Networks",
  "createdBy": "admin",
  "parentDomainId": "0",
  "zoneCount": 0,
  "subDomainCount": 0,
  "subDomains": Object
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the domain",
      "type": "string"
    },
    "name": {
      "description": "Group name",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "domainType": {
      "description": "Group type",
      "type": "string"
    },
    "createdBy": {
      "description": "Created by",
      "type": "string"
    },
    "zoneCount": {
      "description": "# of devices",
      "type": "Integer"
    },
    "subDomainCount": {
      "description": "# of subgroups",
      "type": "integer"
    },
    "subDomains": {
      "description": "sub groups list",
      "type": "array"
    }
  }
}

 

GET /v1_0/aps/

Retrieve list of APs for a group or an Unleashed network/ZD.

URI Parameters

Index               string (optional) 

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

listSize            string (optional) 

The maximum number of entries to be retrieved. Default and max: 1000

zoneId             string (optional) 

filter AP list by device

domainId        string (optional) 

filter AP list by domain. Default: 0(all aps)

Response  200

Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "mac": "00:11:22:33:44:55",
      "zoneId": "1",
      "apGroupId": "1",
      "name": "apName",
      "version": "200.8.10.3.15679977",
      "ipAdd": "10.223.34.240",
      "model": "r510",
      "assocStations": 0,
      "serialNumber": "471839001246",
      "connection": 1,
      "uplinkRSSI": 0,
      "downlinkRSSI": 0,
      "uptime": 1362823    },
    {
      "mac": "11:22:33:44:55:66",
      "zoneId": "2",
      "apGroupId": "2",
      "name": "apName2",
      "version": "10.3.0.0.266",
      "ipAdd": "192.168.1.102",
      "model": "r500",
      "assocStations": 0,
      "serialNumber": "991584200841",
      "connection": 1,
      "uplinkRSSI": 0,
      "downlinkRSSI": 0,
      "uptime": 3545434
    }
  ]
}
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": "AP MAC address",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "zoneId": {
            "description": "ID of the device to which the AP belongs",
            "type": "string"
          },
          "apGroupId": {
            "description": "AP group ID",
            "type": "string"
          },
          "name": {
            "description": "AP name",
            "type": "string"
          },
          "version": {
            "description": "AP version",
            "type": "string"
          },
          "ipAdd": {
            "description": "AP IP address",
            "type": "string"
          },
          "model": {
            "description": "AP model",
            "type": "string"
          },
          "assocStations": {
            "description": "Number of associated clients",
            "type": "string"
          },
          "serialNumber": {
            "description": "AP serial number",
            "type": "string"
          },
          "connection": {
            "description": "AP connection state",
            "type": "string"
          },
          "uplinkRSSI": {
            "description": "AP mesh uplink RSSI",
            "type": "string"
          },
          "downlinkRSSI": {
            "description": "AP mesh downlink RSSI",
            "type": "string"
          },
          "uptime": {
            "description": "AP uptime",
            "type": "string"
          }
        }
      }
    }
  }
}

 

 

 

GET /v1_0/rkszones/

Retrieve the list of managed Unleashed networks and ZDs that belong to specified group. By default, UMM will response all managed Unleashed networks and ZDs.

URI Parameters

Index               string (optional) 

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

listSize            string (optional) 

The maximum number of entries to be retrieved. Default and max: 1000

domainId        string (optional) 

Group ID. Default: 0

Response  200

Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 1,
  "list": [
    {
      "id": "1",
      "name": "device Name",
      "serialNumber": "xxxx",
      "macAddress": "aa:bb:cc:dd:ee:ff",
      "model": "Unleashed",
      "sshConnect": 0,
      "connection": 0,
      "connectMember": 0,
      "disconnectMember": 0,
      "version": "200.8.10.3.222"
    },
    {
      "id": "2",
      "name": "device Name2",
      "serialNumber": "yyyy",
      "macAddress": "aa:bb:cc:dd:ee:aa",
      "model": "Unleashed",
      "sshConnect": 0,
      "connection": 0,
      "connectMember": 0,
      "disconnectMember": 0,
      "version": "200.8.10.3.222"
    }
  ]
}
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 device",
            "type": "string"
          },
          "name": {
            "description": "Name of the device",
            "type": "string"
          },
          "serialNumber": {
            "description": "Serial Number of the device",
            "type": "string"
          },
          "macAddress": {
            "description": "MacAddress of the device",
            "type": "string"
          },
          "model": {
            "description": "Model of the device",
            "type": "string"
          },
          "sshConnect": {
            "description": "State of ssh tunnel",
            "type": "Integer"
          },
          "connection": {
            "description": "State of device TR069 connection",
            "type": "Integer"
          },
          "connectMember": {
            "description": "Count of connected APs",
            "type": "Integer"
          },
          "disconnectMember": {
            "description": "Count of disconnected APs",
            "type": "Integer"
          },
          "version": {
            "description": "device version",
            "type": "string"
          }
        }
      }
    }
  }
}

 

GET /v1_0/rkszones/{id}

Retrieve specified Unleashed networks and ZDs configuration by id.

Response  200

Body
{
  "id": "11",
  "name": "albert_r720",
  "serialNumber": "un4317030008211573457679941",
  "macAddress": "3a:aa:9f:1d:14:90",
  "model": "Unleashed",
  "sshConnect": 1,
  "connection": 1,
  "connectMember": 1,
  "disconnectMember": 0,
  "version": "200.8.10.3.15734558",
  "location": null,
  "latitude": null,
  "longitude": null,
  "ipv6Address": "",
  "ipAddress": "10.223.57.204",
  "externalIP": "10.223.57.204",
  "externalPort": 443,
  "managementIP": null,
  "managementPort": 443,
  "managementIPv6": null,
  "lastSeen": "2019-11-12 16:08:10.0",
  "upTime": 88196,
  "inventoryStatus": "Permitted",
  "totalTxBytes": 2317392557,
  "totalTxPkts": 3344345,
  "totalRxBytes": 125292773,
  "totalRxPkts": 1065917,
  "assocNumSta": 1,
  "numSta": 1,
  "rxBytes": 316552,
  "txBytes": 18007465,
  "rxPkts": 11575,
  "txPkts": 79797
}
Schema
{
    "type": "object",
    "additionalProperties" : false,
    "properties": {
        "id": {
            "description": "Id of the device",
            "type": "string"
        },
        "name": {
            "description”: "Name of the device",
            "type”: "string"
        },
        "serialNumber”: {
            "description”: "Serial Number of the device",
            "type”: "string"
        },
        "macAddress”: {
            "description”: "MACAddress of the device",
            "type”: "string"
        },
        "model”: {
            "description”: "Model of the device",
            "type”: "number"
        },
        "sshConnect”: {
            "description”: "State of ssh tunnel ",
            "type”: "number"
        },
        "connection": {
            "description": "State of device TR069 connection ",
            "type": "number"
        },
        "connectMember": {
            "description”: "Count of connected APs ",
            "type”: "number"
        },
        "disconnectMember”: {
            "description”: "Count of disconnected APs ",
            "type”: "number"
        },
        "version”: {
            "description”: "Device firmware version",
            "type”: "string"
        },
        "location”: {
            "description”: "Device location",
            "type”: "string"
        },
        "latitude”: {
            "description”: "Latitude coordinate (in decimal format)",
            "type”: "number"
        },
        "longitude": {
            "description": "Longitude coordinate (in decimal format)",
            "type": "number"
        },
        "ipv6Address": {
            "description”: "IPv6 address",
            "type”: "string"
        },
        "ipAddress”: {
            "description”: " IPv4 address ",
            "type”: "string"
        },
        "externalIP”: {
            "description”: "Device external IP",
            "type”: "string"
        },
        "externalPort”: {
            "description”: "Device external port",
            "type”: "number"
        },
        "managementIP": {
            "description": "Management IP",
            "type": "string"
        },
        "managementPort": {
            "description”: "Management port",
            "type”: "number"
        },
        "managementIPv6”: {
            "description”: "Management IPv6 address",
            "type”: "string"
        },
        "lastSeen”: {
            "description”: "Last time seen this device",
            "type”: "string"
        },
        "upTime”: {
            "description”: "uptime",
            "type”: "number"
        },
        "inventoryStatus”: {
            "description”: "Device management status",
            "type”: "number"
        },
        "totalTxBytes": {
            "description": "Total traffic",
            "type": "string"
        },
        "totalTxPkts": {
            "description”: "Total packages",
            "type”: "string"
        },
        "totalRxBytes”: {
            "description”: "Total traffic",
            "type”: "string"
        },
        "totalRxPkts”: {
            "description”: "Total packages",
            "type”: "string"
        },
        "assocNumSta”: {
            "description”: "Authorized client number",
            "type”: "number"
        },
        "numSta”: {
            "description”: "current connected client number",
            "type”: "number"
        },
        "rxBytes": {
            "description": "Received traffic",
            "type": "number"
        },
        "txBytes": {
            "description”: "Transport traffic",
            "type”: "number"
        },
        "rxPkts”: {
            "description”: "Received packets",
            "type”: "number"
        },
        "txPkts”: {
            "description”: "Transport packets",
            "type”: "number"
        }
    }
}

 

GET /v1_0/rkszones/sn/{sn}

Retrieve specified Unleashed networks and ZDs configuration by serial number.

Response  200

Body
{
  "id": "11",
  "name": "albert_r720",
  "serialNumber": "un4317030008211573457679941",
  "macAddress": "3a:aa:9f:1d:14:90",
  "model": "Unleashed",
  "sshConnect": 1,
  "connection": 1,
  "connectMember": 1,
  "disconnectMember": 0,
  "version": "200.8.10.3.15734558",
  "location": null,
  "latitude": null,
  "longitude": null,
  "ipv6Address": "",
  "ipAddress": "10.223.57.204",
  "externalIP": "10.223.57.204",
  "externalPort": 443,
  "managementIP": null,
  "managementPort": 443,
  "managementIPv6": null,
  "lastSeen": "2019-11-12 16:08:10.0",
  "upTime": 88196,
  "inventoryStatus": "Permitted",
  "totalTxBytes": 2317392557,
  "totalTxPkts": 3344345,
  "totalRxBytes": 125292773,
  "totalRxPkts": 1065917,
  "assocNumSta": 1,
  "numSta": 1,
  "rxBytes": 316552,
  "txBytes": 18007465,
  "rxPkts": 11575,
  "txPkts": 79797
}
Schema
{
    "type": "object",
    "additionalProperties" : false,
    "properties": {
        "id": {
            "description": "Id of the device",
            "type": "string"
        },
        "name": {
            "description”: "Name of the device",
            "type”: "string"
        },
        "serialNumber”: {
            "description”: "Serial Number of the device",
            "type”: "string"
        },
        "macAddress”: {
            "description”: "MACAddress of the device",
            "type”: "string"
        },
        "model”: {
            "description”: "Model of the device",
            "type”: "number"
        },
        "sshConnect”: {
            "description”: "State of ssh tunnel ",
            "type”: "number"
        },
        "connection": {
            "description": "State of device TR069 connection ",
            "type": "number"
        },
        "connectMember": {
            "description”: "Count of connected APs ",
            "type”: "number"
        },
        "disconnectMember”: {
            "description”: "Count of disconnected APs ",
            "type”: "number"
        },
        "version”: {
            "description”: "Device firmware version",
            "type”: "string"
        },
        "location”: {
            "description”: "Device location",
            "type”: "string"
        },
        "latitude”: {
            "description”: "Latitude coordinate (in decimal format)",
            "type”: "number"
        },
        "longitude": {
            "description": "Longitude coordinate (in decimal format)",
            "type": "number"
        },
        "ipv6Address": {
            "description”: "IPv6 address",
            "type”: "string"
        },
        "ipAddress”: {
            "description”: " IPv4 address ",
            "type”: "string"
        },
        "externalIP”: {
            "description”: "Device external IP",
            "type”: "string"
        },
        "externalPort”: {
            "description”: "Device external port",
            "type”: "number"
        },
        "managementIP": {
            "description": "Management IP",
            "type": "string"
        },
        "managementPort": {
            "description”: "Management port",
            "type”: "number"
        },
        "managementIPv6”: {
            "description”: "Management IPv6 address",
            "type”: "string"
        },
        "lastSeen”: {
            "description”: "Last time seen this device",
            "type”: "string"
        },
        "upTime”: {
            "description”: "uptime",
            "type”: "number"
        },
        "inventoryStatus”: {
            "description”: "Device management status",
            "type”: "number"
        },
        "totalTxBytes": {
            "description": "Total traffic",
            "type": "string"
        },
        "totalTxPkts": {
            "description”: "Total packages",
            "type”: "string"
        },
        "totalRxBytes”: {
            "description”: "Total traffic",
            "type”: "string"
        },
        "totalRxPkts”: {
            "description”: "Total packages",
            "type”: "string"
        },
        "assocNumSta”: {
            "description”: "Authorized client number",
            "type”: "number"
        },
        "numSta”: {
            "description”: "current connected client number",
            "type”: "number"
        },
        "rxBytes": {
            "description": "Received traffic",
            "type": "number"
        },
        "txBytes": {
            "description”: "Transport traffic",
            "type”: "number"
        },
        "rxPkts”: {
            "description”: "Received packets",
            "type”: "number"
        },
        "txPkts”: {
            "description”: "Transport packets",
            "type”: "number"
        }
    }
}

 

 

GET /v1_0/rkszones/{id}/mesh

Retrieve mesh configuration of specified Unleashed network or ZD. First level is device info, the mesh view info if start from second level in ‘subMeshViews’. Next example is one of the value in second level.

Response  200

Body
{
    "actions": "",
    "apCoordinates": "22.54272,113.95181",
    "apDescription": "R600",
"apGps": "22.54272,113.95181",
"apId": null,
"apIp": "192.168.23.142",
"apLastSeen": 1554196419,
"apLocation": "dachong2",
"apMac": "38:ff:36:3a:83:70",
"apMacLink": null,
"apModelName": "r600",
"apName": "R600",
"apNumberOfClients": "0",
"apRadioChannel": "149 ()",
"apRssi": null,
"apSerial": "451503802063",
"apState": 1,
"apUptime": "39d 2h 56m",
"apVersion": "200.7.10.2.339",
"deviceId": 2,
"icon": "./images/tree/16RootAPGreen.png",
"latitude": 22.54272,
"level": 0,
"linkCount": null,
"location": "dachong2",
"longitude": 113.95181,
"meshCount": null,
"nodeType": "root",
"rootCount": null,
"subMeshViews": null,
"zdAp_ipv6": ""
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "nodeType" : {
            "description" : "mesh node type",
            "type" : "string"
        },
        "apName" : {
            "description" : "Name of the ap",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "apMac": {
            "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])$"
          },
        "apRadioChannel": {
            "description": "Radio channel of the AP",
            "type": "string"
          },
        "apDescription": {
            "description": "Description of the AP",
            "type": "string"
          },
        "icon": {
            "description": "Icon name and path of the AP in server",
            "type": "string"
          },
        "apRssi": {
            "description": "RSSI of the AP",
            "type": "string"
          },
        "apModelName": {
            "description": "Model name of the AP",
            "type": "string"
          },
        "apSerial": {
            "description": "Serial number of the AP",
            "type": "string"
          },
        "apIp": {
            "description": "Ip of the AP",
            "type": "string"
          },
        "apCoordinates": {
            "description": "Coordinates of the AP",
            "type": "string"
          },
        "apNumberOfClients": {
            "description": "Clients number of the AP",
            "type": "string"
          },
        "apUptime": {
            "description": "Uptime of the AP",
            "type": "string"
          },
        "apId": {
            "description": "Id of the AP",
            "type": "string"
          },
        "apState": {
            "description": "State of the AP",
            "type": "number"
          },
        "apLastSeen": {
            "description": "LastSeen of the AP",
            "type": "number"
          },
        "zdAp_ipv6": {
            "description": "Ipv6 of the AP",
            "type": "string"
          },
        "deviceId": {
            "description": "Id of the controller",
            "type": "string"
          },
        "apMacLink": {
            "description": "Mac link of the AP",
            "type": "string"
          },
        "apGps": {
            "description": "Gps of the AP",
            "type": "string"
        "apVersion" : {
            "description" : "AP firmware version of the device",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "location" : {
            "description" : "Location of the Device.",
            "type" : "string"
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the device",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the device",
            "type" : "number"
        },
        "list": {
          "type": "array",
          "items": "Object like the parent item"
        }
    }
}

 

 

GET /v1_0/rkszones/{zoneId}/wlans

Retrieve list of WLANs by specified Unleashed network or ZD.

URI Parameters

Index string (optional) 

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

listSize string (optional) 

The maximum number of entries to be retrieved. Default and max: 1000

Response  200

Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "1",
      "enc": "wap2",
      "zoneId": "1",
      "name": "wlan2",
      "ssid": "wlan2",
      "authc": "open",
      "state": "enabled"
    },
    {
      "id": "2",
      "enc": "wap2",
      "zoneId": "1",
      "name": "wlan1",
      "ssid": "wlan1",
      "authc": "open",
      "state": "enabled"
    }
  ]
}
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"
          },
          "enc": {
            "description": "Enc. of the WLAN",
            "type": "string"
          },
          "name": {
            "description": "Name of the WLAN",
            "type": "string"
          },
          "ssid": {
            "description": "SSID of the WLAN",
            "type": "string"
          },
          "zoneId": {
            "description": "Device ID",
            "type": "string"
          },
          "authc": {
            "description": "Authentication status",
            "type": "string"
          },
          "state": {
            "description": "WLAN state",
            "type": "string"
          }
        }
      }
    }
  }
}

 

PUT /v1_0/rkszones/{zoneId}/wlans

Modify SSID/PSK information for specified WLANs.

Request

Body
{
  "name": "wlanOpen",
  "password": "wlanSSID",
  "saePassword": "wpa3password", //wpa3 or wap23-mixed
  "zones": [
    {
      "id": "3",
      "wlanId": "1",
      "enc": "wpa2"
},
    {
      "id": "4",
      "wlanId": "1",
      "enc": "wpa2"
}
  ]
}
Schema
{
    "type”: "object",
    "additionalProperties": false,
    "properties": {
        "name": {
            "description": "New name and SSID for the WLAN",
            "type": "string",
            "minLength": 1,
            "maxLength": 32
        },
        "password": {
            "description": "New password for the WLAN",
            "type": "string"
        },
        "saePassword": {
            "description": "New password for the WLAN which is wpa3 or wap23-mixed",
            "type": "string"
        },
 
        "zones": {
            "description": "WLAN entities.",
            "type": "array",
            "additionalProperties": false,
            "properties": {
                "id": {
                    "description": "Device id.",
                    "type": "string"
                },
                "wlanId": {
                    "description": "WLAN id.",
                    "type": "string"
                },
                "enc": {
                    "description": "Enc of wlan",
                    "type": "string"
                }
            }
        }
 
}

Response  204

 

PATCH /v1_0/rkszones/wlans/state

Modify WLAN state information for specified WLANs.

Request

Body
{
  "state": "enabled",
  "zones": [
    {
      "id": "3",
      "wlanId": "1"
},
    {
      "id": "4",
      "wlanId": "1"
}
  ]
}
Schema
{
    "type”: "object",
    "additionalProperties": false,
    "properties": {
        "state": {
            "description": "WLAN state string",
            "type": "string"
        },
        "zones": {
            "description": "WLAN entities.",
            "type": "array",
            "additionalProperties": false,
            "properties": {
                "id": {
                    "description": "Device id.",
                    "type": "string"
                },
                "wlanId": {
                    "description": "WLAN id.",
                    "type": "string"
                }
            }
        }
 
}

Response  204

 

 

GET /v1_0/clients/byZone/{id}

Retrieve list of clients by Unleashed network or ZD.

URI Parameters

Index               string (optional) 

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

listSize            string (optional) 

The maximum number of entries to be retrieved. Default and max: 1000

Response  200

Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "1",
      "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": "Device Id of the Block Client for clone in System Domain",
            "type": "string"
          },
          "description": {
            "description": "Description of the Block Client",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "modifiedDateTime": {
            "description": "Date blocked of the Block Client",
            "type": "integer"
          },
          "modifierUsername": {
            "description": "Modifier blocked of the Block Client",
            "type": "string"
          }
        }
      }
    }
  }
}

 

POST /v1_0/alert/alarm/list

Retrieve alarms with specified filters.

Request

Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "0"
    }
  ],
  "sortInfo": {
    "sortColumn": "time",
    "dir": "DESC"
  },
  "page": 1,
  "limit": 10
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "DOMAIN",     --required this or ‘ZONE’
              "ZONE",       --required this or ‘DOMAIN’
              "ALARMTYPE",  --"active"/"history"
              "PERIOD",     -- a time by millisecond
              "SEVERITY"    -- a number from 0 to 4
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": {
            "description": "string",
            "enum": [
              "time"
            ]
          }
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  }
}

Response  200

Body
{
  "rawDataTotalCount": 3,
  "totalCount": 3,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "AlarmUUID1",
      "insertionTime": 1487670600858,
      "alarmType": "Memory threshold exceeded",
      "alarmCode": 951,
      "severity": "Critical",
      "activity": "Memory threshold [95.15%] exceeded on control plane [ui206-C].",
      "acknowledged": "No",
      "ackTime": null
    },
    {
      "id": "AlarmUUID2",
      "insertionTime": 1487666250201,
      "alarmType": "AP disconnected",
      "alarmCode": 303,
      "severity": "Major",
      "activity": "AP [[email protected]94:F6:65:3C:93:C0] disconnected.",
      "acknowledged": "Yes",
      "ackTime": 1487735042472
    }
  ],
  "extra": null
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "description": "",
      "type": "integer"
    },
    "hasMore": {
      "description": "",
      "type": "boolean"
    },
    "totalCount": {
      "description": "",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": "false",
        "type": "object",
        "properties": {
          "ackTime": {
            "type": "number"
          },
          "acknowledged": {
            "type": "string"
          },
          "activity": {
            "type": "string"
          },
          "alarmCode": {
            "type": "integer"
          },
          "alarmType": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "insertionTime": {
            "type": "number"
          },
          "severity": {
            "type": "string"
          }
        }
      }
    },
    "rawDataTotalCount": {
      "description": "",
      "type": "integer"
    }
  }
}

 

POST /v1_0/alert/event/list

Retrieve events with specified filters.

Request

Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "sortInfo": {
    "sortColumn": "time",
    "dir": "DESC"
  },
  "page": 1,
  "limit": 10
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "DOMAIN",     --required this or ‘ZONE’
              "ZONE",       --required this or ‘DOMAIN’
              "PERIOD",     -- a time by millisecond
              "SEVERITY"    -- a number from 0 to 4
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": {
            "description": "string",
            "enum": [
              "time"
            ]
          }
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  }
}

Response  200

Body
{
  "rawDataTotalCount": 287,
  "totalCount": 287,
  "hasMore": true,
  "firstIndex": 70,
  "list": [
    {
      "eventType": "Memory threshold exceeded",
      "eventCode": 951,
      "severity": "Critical",
      "activity": "Memory threshold [89.73%] exceeded on control plane [ui206-C]."
    },
    {
      "eventType": "AP health high airtime utilization clear",
      "eventCode": 348,
      "severity": "Informational",
      "activity": "AP [[email protected]94:F6:65:3C:93:C0] cleared 2.4GHz} airtime utilization health [24], which is no longer past the threshold [70]."
    },
    {
      "eventType": "AP channel updated",
      "eventCode": 306,
      "severity": "Informational",
      "activity": "AP [[email protected]94:F6:65:3C:93:C0] detected interference on radio [11g/n] and has switched from channel [8] to channel [6]."
    }
  ],
  "extra": null
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "description": "",
      "type": "integer"
    },
    "hasMore": {
      "description": "",
      "type": "boolean"
    },
    "totalCount": {
      "description": "",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": "false",
        "type": "object",
        "properties": {
          "activity": {
            "type": "string"
          },
          "eventCode": {
            "type": "integer"
          },
          "eventType": {
            "type": "string"
          },
          "severity": {
            "type": "string"
          }
        }
      }
    },
    "rawDataTotalCount": {
      "description": "",
      "type": "integer"
    }
  }
}

 

 

POST /v1_0/switch/

Retrieve managed ICX switch information with specified filters.

Request

Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "sortInfo": {
    "sortColumn": "time",
    "dir": "DESC"
  },
  "page": 1,
  "limit": 10
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "DOMAIN"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          }
        }
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": {
            "description": "string",
            "enum": [
              "serialNumber"
            ]
          }
        },
        "dir": {
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  }
}

Response  200

Body
{
  "rawDataTotalCount": 287,
  "totalCount": 287,
  "hasMore": true,
  "firstIndex": 70,
  "list": [
    {
      "id": "AVpeTrTUyxBWfBW4Kn0G",
      "switchName": "ICX7450-24P Switch",
      "macAddress": "cc:4e:24:89:a5:98",
      "model": "ICX7450-24-HPOE",
      "ipAddress": "172.18.110.129",
      "upTime": 20000,
      "firmwareVersion": "SPS08080b",
      "modules": "switch",
      "serialNumber": "CYU3333K00L",
      "status": "ONLINE"
    }
  ]
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "description": "",
      "type": "integer"
    },
    "hasMore": {
      "description": "",
      "type": "boolean"
    },
    "totalCount": {
      "description": "",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": "false",
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "switchName": {
            "type": "string"
          },
          "macAddress": {
            "type": "string"
          },
          "model": {
            "type": "string"
          },
          "ipAddress": {
            "type": "string"
          },
          "upTime": {
            "type": "number"
          },
          "firmwareVersion": {
            "type": "string"
          },
          "modules": {
            "type": "string"
          },
          "serialNumber": {
            "type": "string"
          },
          "status": {
            "type": "string"
          }
        }
      }
    }
  }
}

 

GET /v1_0/switch/{id}

Retrieve specified ICX switch configuration.

Response  200

Body
{
      "id": "AVpeTrTUyxBWfBW4Kn0G",
      "switchName": "ICX7450-24P Switch",
      "macAddress": "cc:4e:24:89:a5:98",
      "model": "ICX7450-24-HPOE",
      "ipAddress": "172.18.110.129",
      "upTime": 20000,
      "firmwareVersion": "SPS08080b",
      "modules": "switch",
      "serialNumber": "CYU3333K00L",
      "status": "ONLINE",
      "registrationStatus": "APPROVED",
      "numOfUnits": 1
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
          "id": {
            "type": "string"
          },
          "switchName": {
            "type": "string"
          },
          "macAddress": {
            "type": "string"
          },
          "model": {
            "type": "string"
          },
          "ipAddress": {
            "type": "string"
          },
          "upTime": {
            "type": "number"
          },
          "firmwareVersion": {
            "type": "string"
          },
          "modules": {
            "type": "string"
          },
          "serialNumber": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "registrationStatus": {
            "type": "string"
          },
          "numOfUnits": {
            "type": "number"
          }
    }
}

 

POST /v1_0/switch/clients

Retrieve LLDP information of ICX switches with specified group or switch id.

Request

Body
{
  "filters": [
    {
      "type": "Domain",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ], 
  "extraFilters": [
    {
      "type": "SWITCH",
      "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",
            "enum": [
              "Domain"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          }
        }
      }
    },
    "extraFilters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Switch Id",
            "enum": [
              "SWITCH"
            ]
          },
          "value": {
            "description": "Switch ID",
            "type": "string"
          }
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  }
}

Response  200

Body
{
  "rawDataTotalCount": 287,
  "totalCount": 287,
  "hasMore": true,
  "firstIndex": 70,
  "list": [
    {
      "id": "cc:4e:24:6d:1d:b860:9c:9f:bc:88:d0_1",
      "localPortMac": "60:9c:9f:bc:88:d0",
      "remotePortMac": "cc:4e:24:6d:1d:b8",
      "remoteDeviceName": "3TINBSW",
      "remotePortType": "Bridge, Router",
      "remotePortDesc": "",
      "localPort": "GigabitEthernet2/1/45",
      "remotePort": "GigabitEthernet1/1/18",
      "isRuckusAP": "false",
      "domainId": "9eb6080d-d51f-4ed7-84c7-b16eb75d0a57",
      "tenantId": "",
      "switchGroupLevelOneId": "27c34c93-34d6-448f-b0be-6ee5059f6f28",
      "switchGroupLevelTwoId": "",
      "switchId": "60:9C:9F:BB:D8:34",
      "unitId": "",
      "localPortIfaceName": null,
      "switchName": "MN133",
      "switchGroup": "Rack_A31",
      "sampledInstant": null
    }
  ]
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "description": "",
      "type": "integer"
    },
    "hasMore": {
      "description": "",
      "type": "boolean"
    },
    "totalCount": {
      "description": "",
      "type": "integer"
    },
    "rawDataTotalCount": {
      "description": "",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": "false",
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "localPortMac": {
            "type": "string"
          },
          "remotePortMac": {
            "type": "string"
          },
          "remoteDeviceName": {
            "type": "string"
          },
          "remotePortType": {
            "type": "string"
          },
          "remotePortDesc": {
            "type": "number"
          },
          "localPort": {
            "type": "string"
          },
          "remotePort": {
            "type": "string"
          },
          "isRuckusAP": {
            "type": "string"
          },
          "domainId": {
            "type": "string"
          },
          "tenantId": {
            "type": "string"
          },
          "switchGroupLevelOneId": {
            "type": "string"
          },
          "switchGroupLevelTwoId": {
            "type": "string"
          },
          "switchId": {
            "type": "string"
          },
          "unitId": {
            "type": "string"
          },
          "localPortIfaceName": {
            "type": "string"
          },
          "switchName": {
            "type": "string"
          },
          "switchGroup": {
            "type": "string"
          },
          "sampledInstant": {
            "type": "string"
          }
        }
      }
    }
  }
}

 

POST /v1_0/switch/alarms

Retrieve alarms for ICX switches with specified filters.

Request

Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "0"
    }
  ],
  "extraFilters": [
    {
      "type": "SWITCH",
      "value": "1"
    }
  ], 
  "sortInfo": {
    "sortColumn": "time",
    "dir": "DESC"
  },
  "page": 1,
  "limit": 10
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "enum": [
              "DOMAIN",     --required this or ‘SWITCH’
              "ALARMTYPE",  --"active"/"history"
              "PERIOD",     -- a time by millisecond
              "SEVERITY"    -- a number from 0 to 4
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"