Bulk Device Updates - SNMP

Update devices in your IoT Security inventory with device information that Cortex XSOAR retrieves from integrated switches through SNMP.

Query Parameters

• customerid string required

  The customer ID to which the API call is directed

• updateSource string required

  The source of the device information: SNMP

application/json

Request Body required

• devicelist object[] required

  Array of device attributes from integrated switches using SNMP

  Array [

  deviceid string

  The MAC address of a device connected to a switch. IoT Security uses it to link device attributes from a switch to a device in its inventory.

  connect_evtContent.ip string

  The IP address of the device connected to a switch

  display_switchName string

  The name of the switch to which the device is connected

  display_phyPort string

  The physical port on the switch to which the device is connected. Only Cisco Catalyst switches return this information.

  display_switchIP string

  IP addresses of neighboring switches

  ]

Responses

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

Loading...