APs

Here,

• macaddress

  It is used to specify macaddress of the managed device for which visible APs has to be displayed.

• locationid

  Is used to specify Location on which list of visible APs 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.

Here,

• startIndex

  An integer value indicating the starting index for the list
  of APs to be fetched.

• pageSize

  An integer value indicating the ending index for the list of APs
  to be fetched. Maximum page size is 1000.

• sortcolumn

  Is used to specify Sort column. It takes string value.
  Default value is boxId.

• sortascending

  Is used to specify Sort direction. It takes boolean value.
  Default value is true.

• filter

  Is used 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, data types, applicable values, and whether the
  results can be sorted based on the parameter click AP Filter Parameters.

• previousLink

  Link to access previous group of clients from the list of paged AP.
  It takes a string value. Sample value, /aps/0/25.

• nextLink

  Link to access next group of clients from the list of paged AP.
  It takes String value.

• totalCount

  Total number of paged AP. It takes an integer value.

• macaddress

  Is a string value representing the MAC address of the client radio. For example, 28:47:AA:5B:54:08.

• groupby

  A field applicable for the group by operation. It takes String value.
  Possible values are capability, opprotocol, ssid, channel, security, dosattackstatus, signalstrength, isguest, channeloffset, firstdetectedtime, upsince, quarantinestatus, captureflag, captureid, preventionflags, preventionpendingreason, preventionreason, meshflag, dotncapability, dotaccapability, dualband, misconfigured, securitysettingsfailure, supportedrates, beaconinterval, mcsset11n, mcsset11ac, potentialclassification, isactive, isplaced, boxid, name, devicenote, group, locationid, ipaddress, manuallytagged, vendor, banned, signalsource, manuallyclassified, ownsensorboxid, numberofassociations, and suspiciousvalue.

• filter

  Is used 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, data types, applicable values, and whether the
  results can be sorted based on the parameter click AP Filter Parameters.

• operator

  is used to specify the logical operator on which filtering is to be done. Possible values are AND and OR.

{
    "samples": [
        {
            "group": {
                "vendor": "Arista"
            },
            "count": 43
        }
    ],
    "totalCount": 43
}

• mac

  Is a string value representing the MAC address of the AP. For example, 28:47:AA:5B:54:08.

• protocol

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

• boxid

  System-generated ID of the AP. It takes an integer value.

• unplacedeviceforlocationchange

  A boolean value indicates that before changing the location,
  the device is to be unplaced or not.

• boxIds

  The system-generated ID of the AP. It takes an integer value. Sample value, 74.

• active

  It takes a boolean value. Sample value, false.

• name

  It takes a string value. sample value, Mojo_90:05:21.

• type

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

A sample request will have a structure as follows:

 {
        "type": "ap",
        "boxId": 74,
        "name": "Mojo_90:05:21",
        "active": false
 }

• boxIds

  System-generated ID of the AP. It takes an integer value.
  Sample value, 109.

• type

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

• booleanAction

  If boolean action is set to true than the list of mentioned APs
  is added to the banned list. Else is removed from the banned list. It takes a boolean value.
  Sample value, true.

Sample request body is as follows:

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

• boxIds

  System-generated ID of the AP. It takes an integer value.
  Sample value, 45.

• type

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

• group

  The device category. It takes a string value. The applicable values are:

  • AUTHORIZED
  • MISCONFIGURED
  • ROGUE
  • EXTERNAL
  • UNCATEGORIZED

Sample request body is as follows:

{
   "boxIds":[74, 1691],
   "argument":
   {
      "type": "apgroupchangeaction",
      "group": "EXTERNAL"
   }
}

Here,

• retaintemplate

  A boolean value represents whether to retain the current device template when change location action
  is performed. If set to true the current device template is retained else a location specific new
  device template is applied.

• unplacedeviceforlocationchange

  A boolean value indicates that before changing the location, the device is to be unplaced or not.

• boxIds

  System-generated ID of the AP. It takes an integer value.
  Sample value, 45.

• type

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

• locationId

  Location identifier for the client.

Sample request body is as follows:

{
   "boxIds": [1691],
   "argument":{
      "type": "location",
      "locationId":{
         "type": "locallocationid",
         "id": "0"
      }
   }
}

• boxIds

  System-generated ID of the AP. It takes an integer value.
  Sample value, 109.

• type

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

• addPrevention
• preventionType

  Possible values are:

  • PREV_TYPE_DoS = 3
  • PREV_TYPE_PORT_BLOCK = 6
  • PREV_TYPE_AP = 1<
  • PREV_TYPE_CLIENT = 2

  It takes an integer value. Sample value, 6.

• radio

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

• radio/type

  Type of a radio. The expected value is apradio. It takes a string value.
  Sample value, apradio.

• radio/macaddress

  MAC address of the device. It takes a string value.
  Sample value, 00:11:74:90:64:10.

• radio/protocol

  Protocol of the device. The applicable values are:

  • UNKNOWN
  • A
  • B
  • BG

  It takes a string value. Sample value, BG.

Sample request body is as follows:

{
   "boxIds":[1691],
   "argument":{
      "type": "quarantinestatusarguments",
      "addPrevention": true,
      "preventionType": 0,
      "radio":{
         "type": "apradio",
         "macaddress": "00:11:74:A0:14:82",
         "protocol": "BG"
      }
    }
}

{
   "boxIds":[1737]
}

• boxIds

  System-generated ID of the AP. It takes an integer value.
  Sample value, 252.

• type

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

• booleanAction

  If boolean action is set to true than the auto quarantine status for mentioned APs is enabled.
  Else it is disabled. It takes a boolean value. Sample value, true.

Sample request body is as follows:

{
   "boxIds":[74, 1691],
   "argument":
   {
      "type": "boolean",
      "booleanAction": false
   }
}

• boxIds

  System-generated ID of the AP. It takes an integer value.
  Sample value, 1318.

• type

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

• booleanAction

  If boolean action is set to true than the auto quarantine status for mentioned APs is enabled.
  Else it is disabled. It takes a boolean value. Sample value, false.

Sample request body is as follows:

{
   "boxIds":[74, 1691],
   "argument":{
      "type": "boolean",
      "booleanAction": true
   }
}

• boxIds

  System-generated ID of the AP. It takes an integer value. Sample value, 155.

• argument/type

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

• argument/primaryAP
• argument/primaryAP/type

  Category or type of the primary device. It takes a string value. Sample value, ap.

• argument/primaryAP/boxId

  System-generated ID of the AP. It takes an integer value. Sample value, 155.

• argument/primaryAP/ownSensorBoxId

  A read-only field for internal use. It takes an integer value. Sample value, -1.

• argument/primaryAP/radios

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

• argument/primaryAP/radios/type

  Type of a radio. The expected value is apradio. It takes a string value. Sample value, apradio.

• argument/primaryAP/radios/macaddress

  MAC address of the device. It takes a string value. Sample value, 00:11:74:90:00:20.

• argument/primaryAP/radios/protocol

  Protocol of the device. It takes a string value. The applicable values are:

  • UNKNOWN
  • A
  • B
  • BG
• argument/primaryAP/locationId

  Location identifier for the client. It takes an integer value.

Sample request body is as follows:

{
   "boxIds":[1732,2154],
   "argument":{
      "type": "mergeapaction",
      "primaryAP":{
         "type": "ap",
         "boxId": 2101,
         "ownSensorBoxId": -1,
         "radios":[{
            "type": "apradio",
            "macaddress": "00:11:74:9C:BC:9F",
            "protocol": "A"
         }],
         "locationId":{
            "type": "locallocationid",
            "id": -1
         }
      }
   }
}

{
   "boxIds":
   [
      2101
   ]

}