Bulk Device Updates - Cisco DNAC and Prime
Update devices in your IoT Security inventory with select device information that Cortex XSOAR retrieves from an integrated Cisco DNA Center or Cisco Prime instance.
Query Parameters
- customerid string required
The customer ID to which the API call is directed
- application/json
Request Body required
devicelist object[] required
Array of device attributes from the integrated DNA Center or Prime instance
Array [deviceid stringThe MAC address of a device in the Cisco DNA Center or Prime inventory. IoT Security uses it to link attributes from a device in the other inventory to one in its own inventory.
config_source stringPossible values: [
dnac
,prime
]The source of the device information: "dnac" or "prime"
ip stringThe device IP address
location stringThe location of the device as learned from the location setting on the Cisco switch or access point to which the device connects
ap_ip stringThe IP address of the access point through which the device makes a wireless connection to the network
ap_name stringThe name of the access point through which the device makes a wireless connection to the network
SSID stringThe SSID on which the device associates with the access point
switchIP stringThe IP address of the switch to which the device makes a wired connection to the network
switchName stringThe hostname of the switch to which the device makes a wired connection to the network
switchPort stringswitch_if_name stringThe Ethernet interface on the switch through which the device makes a wired connection to the network
vlan stringThe ID of the VLAN that the device is in
vlan_name stringThe name of the VLAN that the device is in
WireWireless stringThe type of network connection for the device: wired or wireless
]
- 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."
}