Bulk Device Updates - SNMP

PUT 
/pub/v4.0/device/bulkUpdate?updateSource=snmp

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

Request

Query Parameters

customerid stringrequired

The customer ID to which the API call is directed

updateSource stringrequired

The source of the device information: SNMP

application/json

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

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...