Bulk Device Updates - Cisco DNAC and Prime

PUT 
/pub/v4.0/device/bulkUpdate

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.

Request

Query Parameters

customerid stringrequired

The customer ID to which the API call is directed

application/json

Body

required

devicelist object[]required
Array of device attributes from the integrated DNA Center or Prime instance
Array [
deviceid string
The 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 string
Possible values: [dnac, prime]
The source of the device information: "dnac" or "prime"
ip string
The device IP address
location string
The location of the device as learned from the location setting on the Cisco switch or access point to which the device connects
ap_ip string
The IP address of the access point through which the device makes a wireless connection to the network
ap_name string
The name of the access point through which the device makes a wireless connection to the network
SSID string
The SSID on which the device associates with the access point
switchIP string
The IP address of the switch to which the device makes a wired connection to the network
switchName string
The hostname of the switch to which the device makes a wired connection to the network
switchPort string
switch_if_name string
The Ethernet interface on the switch through which the device makes a wired connection to the network
vlan string
The ID of the VLAN that the device is in
vlan_name string
The name of the VLAN that the device is in
WireWireless string
The type of network connection for the device: wired or wireless
]

Responses

200

Successful Response

application/json

Schema

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

Example (from schema)

{
  "api": "string",
  "ver": "string",
  "code": "string",
  "message": "string",
  "updatedDeviceNum": 0
}

resolveSecurityAlertResponseExample

{
  "api": "device/bulkUpdate",
  "ver": "v4.0",
  "code": 1,
  "message": "OK",
  "updatedDeviceNum": 5
}

4XX

Client Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

{
  "code": "string",
  "msg": "string"
}

Bad Request

{
  "code": 400,
  "msg": "Bad Request. This occurs when an HTTP request contains an invalid query string."
}

Forbidden access

{
  "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."
}

Too many requests

{
  "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."
}

5XX

Server Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

{
  "code": "string",
  "msg": "string"
}

resolveSecurityAlertResponseExample

{
  "code": 500,
  "msg": "Internal server error. A unified status for API communication type errors."
}

Loading...