Bulk Device Updates - Cisco WLC
Update devices in your IoT Security inventory with device information that Cortex XSOAR retrieves from integrated Cisco WLAN controllers.
Query Parameters
- customerid string required
The customer ID to which the API call is directed
- updateSource string required
The source of the device information: Cisco WLAN controllers
- application/json
Request Body required
devicelist object[] required
Array of device attributes from integrated Cisco WLAN controllers
Array [macAddress stringThe MAC address of a wireless client on the Cisco WLAN. IoT Security uses it to link device attributes from Cisco WLAN controllers to a device in its inventory.
ipAddress stringThe wireless client IP address
radio stringThe radio band that the wireless client is using (2.4 GHz or 5 GHz)
connectionState stringWhether the wireless client is connected or not
wlanId stringAn attribute that a WLAN controller sends an AP indicating the SSID an authenticated wireless client should join
SSID stringThe service set identifier (SSID) on which the wireless client associates with the access point
connectedDuration stringThe duration of the wireless client’s current connection
authentication stringWhether or not authentication is required to connect to the WLAN
status stringWhether the wireless client is authenticated or not
authMethod stringThe method the wireless client uses to authenticate: WPA2 PSK, WPA 802.1X, WPA, WEP, open
encryptionCipher stringThe type of cipher the wireless client uses to encrypt communications, such as CCMP-128 (AES) or TKIP
rssi stringThe received signal strength (RSSI) of the wireless client’s connection
snr stringThe signal-to-noise ratio (SNR) of the wireless client’s connection
apName stringThe name of the access point through which the device makes a wireless connection to the network
apIPAddress stringThe IP address of the access point through which the device makes a wireless connection to the network
apMacAddress stringThe MAC address of the access point through which the device makes a wireless connection to the network
apRadioSlotId stringThe radio slot ID on the access point
apModel stringThe access point model
location stringThe location of the device as learned from the location setting on the Cisco switch or access point to which the device connects
country stringThe country for which the device is configured to operate its radio. This affects available radio channels and power levels.
BSSID stringThe MAC address of the wireless interface on which the AP hosts the SSID
apencryptionCipher stringThe set of encryption ciphers for which the AP broadcasts support in its beacons
bluetoothType string(Bluetooth/BLE devices) Whether the wireless client uses Bluetooth or Bluetooth Low Energy (BLE)
bluetoothDeviceType string(Bluetooth/BLE devices) The type of function the device is performing; for example, BLE Beacon
frequency string(Bluetooth/BLE devices) The radio frequency on which the Bluetooth or BLE client is communicating with the AP: 2.4 GHz
channel string(Bluetooth/BLE devices) The radio channel on which the Bluetooth or BLE client is communicating with the AP
isBluetooth booleanWhether the wireless client uses Bluetooth/BLE or not
]
- 200
- 4XX
- 5XX
Successful Response
- application/json
- Schema
- Example (from schema)
- resolveSecurityAlertResponseExample
Schema
- api string
The path used to call the IoT Security API: “device/bulkupdate”
- ver string
The version of the IoT Security API: “v4.0”
- code string
The code number indicating success: 1
- message string
The message indicating success: “OK”
- updatedDeviceNum integer
The number of devices that IoT Security successfully updated
{
"api": "string",
"ver": "string",
"code": "string",
"message": "string",
"updatedDeviceNum": 0
}
{
"api": "device/bulkUpdate",
"ver": "v4.0",
"code": 1,
"message": "OK",
"updatedDeviceNum": 5
}
Client Error Response
- application/json
- Schema
- Example (from schema)
- Bad Request
- Forbidden access
- Too many requests
Schema
- code string
STATUS_CODE
- msg string
GENERAL_MESSAGE
{
"code": "string",
"msg": "string"
}
{
"code": 400,
"msg": "Bad Request. This occurs when an HTTP request contains an invalid query string."
}
{
"code": 403,
"msg": "Forbidden access. Either the provided API key is invalid or it does not have the required RBAC permissions to run this API."
}
{
"code": 429,
"msg": "Too many requests. The number of requests for device details for a single device exceeded the rate limit of 180 queries per minute per tenant."
}
Server Error Response
- application/json
- Schema
- Example (from schema)
- resolveSecurityAlertResponseExample
Schema
- code string
STATUS_CODE
- msg string
GENERAL_MESSAGE
{
"code": "string",
"msg": "string"
}
{
"code": 500,
"msg": "Internal server error. A unified status for API communication type errors."
}