Clients

• macaddress

  It is used to specify macaddress of the managed device for which visible clients has to be displayed. It takes a String value.

• locationid

  Is used to specify Location on which list of the visible client has to be fetched. It takes an integer value.
  Location identifier for the client. To retrieve the value for location Id refer Location call.

• nodeid

  Is used to specify child node id if the location belongs to the child server. It takes an integer value.

• startIndex

  An integer value indicating the start index for the list of clients to be fetched. It is a mandatory parameter.

• pageSize

  An integer value indicating the end index for the list of clients to be fetched.
  The maximum page size is 1000. It is a mandatory parameter.

• sortcolumn

  An optional parameter used to sort the columns. It takes a string value. The default value is boxId.

• sortascending

  An optional parameter used to specify sort direction. It takes a boolean value. The default value is true.

• performancestarttime

  An optional parameter used to specify the start time in epoch format. It takes an integer value. The default value is -1.

• performanceendtime

  An optional parameter used to specify end time in epoch format. It takes an integer value. The default value is -1.

• historicmanagedboxid

  An optional filter to fetch clients which were connected to the managed device in past. It takes an integer value. The default value is -1. To retrieve the value for boxId refer Managed Devices call.

• historicssid

  An optional filter to fetch clients which were associated using provided SSID in past. It takes a string value. To retrieve the value for SSIDs refer Get SSIDs Configured on a Managed Device call.

• historicfrequencyband

  An optional filter to fetch clients which were associated using provided frequency band in past. It takes a string value. Possible values are 2.4, 5 and ANY (default).

• filter

  An optional parameter to filter the results. Click Filter to view details of how filters need to be specified in the URL. For possible names of property attribute, datatypes, applicable values, and whether the results can be
  sorted based on the parameter click Client Filter Parameters.

• limit

  Is used to specify the number of records to be returned. It takes an integer value and is an optional parameter.
  The default value is 10.

• sortby

  Is used to specify the performance value to sort the data on. It takes a string value and is an optional parameter.
  Possible values are networktraffic and datarate. The default value is networktraffic.

• ascending

  Is set true to sort records in ascending order. It takes a boolean value and is an optional parameter.
  The default value is false.

• frequencyband

  Is used to specify filter records of a frequency band. Possible values are 2.4, 5
  and ANY (default). It takes a String value and is an optional parameter.

• fromtime

  Is used to specify the start time in epoch format. It takes an integer value and is an optional parameter.
  The default value is -1.

• totime

  Is used to specify end time in epoch format. It takes an integer value and is an optional parameter.
  The default value is -1.

• managedclient

  Is used to specify if records for managed clients is to be retrieved.
  If set to true, only managed clients will be returned. It takes a boolean value and is an optional parameter.
  The default value is false.

• ssid

  Is used to specify the list of SSIDs for which the results should be returned. It takes a string
  value and is an optional parameter. To retrieve the value for SSIDs refer Get SSIDs Configured on a Managed Device call.

• APPLICATION_ID

  The id of application for which data has to be fetched. It takes an integer value and is a mandatory parameter.

• startIndex

  An integer value indicating the starting index for the list of clients to be fetched. It is a mandatory parameter.

• pageSize

  An integer value indicating the ending index for the list of clients to be fetched. It is a mandatory parameter.
  The maximum page size is 1000.

• applicationcategory

  It specifies the category of application. It takes a string value and is an optional parameter.

• locationid

  Location identifier for the client. The value is of the type LocationID JSON. It is an optional parameter.

• nodeid

  Is used to specify child node id if the location belongs to the child server.
  It takes an integer value and is an optional parameter.

• fromtime

  Is the start time for poor application performance of the clients. Accepts value in a number
  of milliseconds in UTC format. It takes an integer value and is an optional parameter.

• totime

  Is the end time for poor application performance of the clients.
  If not provided current system time is considered. Accepts value in
  number of milliseconds in UTC format. It takes an integer value and is an optional parameter.

• sortcolumn

  Is used to specify Sort column. It takes a string value and is an optional parameter. Default value is boxId.

• sortascending

  Is used to specify Sort direction. It takes a boolean value and is an optional parameter.

• historicssid

  Applications used by clients connected to the given SSID. If not specified,
  all the SSIDs are considered. It takes a string value and is an optional parameter. Sample value, MOJO-BYOD.

• historicfrequencyband

  It is used to specify a frequency band. Possible values are 2.4GHz, 5GHz and ANY.
  The default value is ANY. It is an optional parameter

• boxid

  The mandatory parameter used to specify the client box ID. It takes an integer value. To retrieve the value for boxId refer Managed Device call.

• boxIds

  A unique ID for identifying a device. It’s an integer value. Sample value, 10629.

• macAddress

  MAC address of the device. It’s a string value. Sample value, 00:11:74:D4:59:9F.

• name

  Name of the device. It’s a string value. Mojo_D4:59:9F.
  Sample value, boolean.

• signalStrength

  The signal strength of the client radio in dBm. It’s an integer value. Sample value, -33.

• signalVariance

  Signal variance in dBm. It’s an integer value. Sample value, 0.

• channel2_4Ghz

  The operating channel at 2.4 GHz radio band. It’s an integer value. Sample value, 1.

• channel5Ghz

  The operating channel at 5 GHz radio band. It’s an integer value. Sample value, 149.

• numClients2_4Ghz

  The number of clients on 2.4 GHz radio band. It’s an integer value. Sample value, 3.

• numClients5Ghz

  The number of clients on 5 GHz radio band. It’s an integer value. Sample value, 4.

• locationId

  Location identifier for the client. The value is of the type LocationID JSON.

A sample response is as follows:

[  
   {  
      "boxId":3,
      "macAddress":"00:11:74:DC:4B:5F",
      "name":"Mojo_DC:4B:5F",
      "signalStrength":-66,
      "signalVariance":0,
      "channel2_4Ghz":11,
      "channel5Ghz":161,
      "numClients2_4Ghz":0,
      "numClients5Ghz":0,
      "locationId":{  
         "type":"locallocationid",
         "id":-1
      },
      "troubleshootingActivty":null,
      "meshEnabled":false,
      "thirdRadioSupported":false,
      "troubleshootingActivityOff":false
   }
]

Here,

• reporter — The value for the reporter parameter is a string indicating the reporting entity.

Here,

• reporting_entity_id — is a String value representing the reporting entity.

• type
• radios
• radios/type
• radios/macaddress
• radios/protocol
• locationId
• locationId/type
• locationId/id
• group

A sample request will have a structure as follows:

{
"ClientList":[{
...
List of AP JSONs with the mandatory attributes mentioned above
...
}]
}

• failedDevices – Information of the failed clients. The response is in the application/json format. Click Client to view the complete detais of the JSON along with a sample output.
• successDevices – Information of the successfully imported clients. The response is in the application/json format. Click Client to view the complete detais of the JSON along with a sample output.

{
        "type": "client",
        "boxId": 662,
        "name": "New",
         "radios": [
            {
               "type": "clientradio",
               "macaddress": "AC:BC:32:A3:20:B3"
            }
         ]
 }

Here,

• reporting_entity_id — is a String value representing the reporting entity.

• type
• radios
• radios/type
• radios/macaddress
• radios/protocol
• locationId
• locationId/type
• locationId/id

A sample request will have a structure as follows:

{
"ClientList":[{
...
List of AP JSONs with the mandatory attributes mentioned above
...
}]
}

• failedDevices — Information of the failed clients. The response is in the application/json
  format. Click Client to view the complete detais of the JSON along with a sample output.
• successDevices — Information of the successfully updated clients. The response is in the
  application/json format. Click Client to view the complete detais of the JSON along with a
  sample output.

• boxIds

  It is system-generated ID. It takes an integer value. Sample value, 1.

• type

  Category or type of the client whose details are being modified. It takes a string value.
  Sample value, clientquarantinestatus.

• radio

  A JSON object with attributes related to the access point radio.

• radio/type

  Category or type of the radio. It takes a string value. Expected value is clientradio.

• radio/macaddress

  MAC address of the radio. It takes a string value. Sample value, BC:D1:D3:BA:62:B5

• radio/protocol

  The 802.11 protocol version associated with the device. The applicable values
  are UNKNOWN, A, B, BG. Sample value, BG.

A sample request will have a structure as follows:

{
   "boxIds": 
         [
	    5858, 6264
	 ],
    "argument": 
	 {
	     "type": "clientquarantinestatus",
	     "addPrevention": true,
	     "preventionType": 0,
	     "radio": 
	    {
	       "type": "clientradio",
	       "macaddress": "BC:D1:D3:BA:62:B5",
	       "protocol": "BG"
	    }
         }
}

• boxIds

  It is system-generated ID. It takes an integer value. Sample value, 6432.

• type

  Category or type of the client whose details are being modified. It takes a string value.
  Sample value, location.

• locationId

  Location identifier for the client.

A sample request will have a structure as follows:

{
   "boxIds": [5012, 6432],
   "argument":
	   {
	       "type": "location",
	       "locationId":
		  {
                     "type": "locallocationid",
                     "id": "-1"
                  }
           }
}

• boxIds

  It is system-generated ID. It takes an integer value.

• type

  Category or type of the client whose details are being modified. It takes a string value.

• group

  The client category. The applicable values are AUTHORIZED, ROGUE, EXTERNAL,
  GUEST and UNCATEGORIZED.

A sample request will have a structure as follows:

{
   "boxIds": 
	  [
	     5012, 6432
	  ],
   "argument": 
	  {
	     "type": "clientdevicegroup",
	     "group": "AUTHORIZED"
	  }
}

• boxIds

  It is system-generated ID. It takes an integer value. Sample value, 5012.

• type

  Category or type of the client whose details are being modified. It takes a string value.
  Sample value, boolean.

• booleanAction

  If boolean action is set to true then the list of mentioned clients
  is added to the banned list. Else is removed from the banned list. Sample value, True.

A sample request will have a structure as follows:

{
    "boxIds": 
    [
        5012, 6432
    ],
    "argument": 
    {
        "type": "boolean",
        "booleanAction": true
    }
}

{
    "boxIds": [5012, 6432]    
}

{
    "boxIds": [242]    
}

• boxIds

  It is system-generated ID. It takes an integer value.

• type

  Category or type of the client whose details are being modified. It takes a string value.

• booleanAction

  If boolean action is set to true then the auto quarantine status for
  mentioned clients is enabled. Else it is disabled.

A sample request will have a structure as follows:

{
    "boxIds":[
        5215, 6264
    ],
    "argument":
    {
        "type": "boolean",
        "booleanAction": true
    }
}

{
    "boxIds": [5736, 4901]    
}

{
    "boxIds": 
    [
       5736, 4901
    ],
    "argument": 
    {
        "type": "smartdevice",
        "smartDeviceType": "APPROVED_SMART_DEVICE"
    }
}

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.

Here,

• reporting_entity_id — is a string value representing the reporting entity.

["28:47:AA:5B:54:08","00:21:A0:24:85:A9","00:11:74:47:5D:CF"]

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.