Rediģēt

Kopīgot, izmantojot


Inventory management API reference for OT monitoring sensors

This article lists the device inventory management APIs supported for Defender for IoT OT sensors.

connections (Retrieve device connection information)

Use this API to request a list of all device connections.

URI: /api/v1/devices/connections

GET

Query parameters

Define any of the following query parameters to filter the results returned. If you don't set query parameters, all device connections are returned.

Name Description Example Required / Optional
discoveredBefore Numeric. Filter results that were detected before a given time, where the given time is defined in milliseconds from Epoch time, and in UTC timezone. /api/v1/devices/2/connections?discoveredBefore=<epoch> Optional
discoveredAfter Numeric. Filter results that were detected after a given time, where the given time is defined in milliseconds from Epoch time, and in UTC timezone. /api/v1/devices/2/connections?discoveredAfter=<epoch> Optional
lastActiveInMinutes Numeric. Filter results by a given time frame during which connections were active. Defined backwards, in minutes, from the current time. /api/v1/devices/2/connections?lastActiveInMinutes=20 Optional

connections per device (Retrieve specific device connection information )

Use this API to request a list of all the connections per device.

URI: /api/v1/devices/<deviceID>/connections

GET

Path parameter

Name Description Example Required / Optional
deviceId Get connections for the given device. /api/v1/devices/<deviceId>/connections Required

Query parameters

Name Description Example Required / Optional
discoveredBefore Numeric. Filter results that were detected before a given time, where the given time is defined in milliseconds from Epoch time, and in UTC timezone. /api/v1/devices/2/connections?discoveredBefore=<epoch> Optional
discoveredAfter Numeric. Filter results that were detected after a given time, where the given time is defined in milliseconds from Epoch time, and in UTC timezone. /api/v1/devices/2/connections?discoveredAfter=<epoch> Optional
lastActiveInMinutes Numeric. Filter results by a given time frame during which connections were active. Defined backwards, in minutes, from the current time. /api/v1/devices/2/connections?lastActiveInMinutes=20 Optional

cves (Retrieve information on CVEs)

Use this API to request a list of all known CVEs discovered on devices in the network, sorted by descending CVE score.

URI: /api/v1/devices/cves

GET

Example: /api/v1/devices/cves

Define any of the following query parameters to filter the results returned.

Name Description Example Required / Optional
top Numeric. Determine how many top-scored CVEs to get for each device IP address. /api/v1/devices/cves?top=50

/api/v1/devices/<ipAddress>/cves?top=50
Optional. Default = 100

cves per IP address (Retrieve specific information on CVEs)

Use this API to request a list of all known CVEs discovered on devices in the network for a specific IP address.

URI: /api/v1/devices/cves

GET

Example: /api/v1/devices/cves

Path parameter

Name Description Example Required / Optional
ipAddress Get CVEs for the given IP address. /api/v1/devices/<ipAddress>/cves Required

Define the following query parameter to filter the results returned.

Name Description Example Required / Optional
top Numeric. Determine how many top-scored CVEs to get for each device IP address. /api/v1/devices/cves?top=50

/api/v1/devices/<ipAddress>/cves?top=50
Optional. Default = 100

devices (Retrieve device information)

Use this API to request a list of all devices detected by this sensor.

URI: api/v1/devices/

GET

Query parameter

Define the following query parameter to filter the results returned. If you don't set query parameters, all device connections are returned.

Name Description Example Required / Optional
authorized Boolean:

- true: Filter for data on authorized devices only.
- false: Filter for data on unauthorized devices only.
/api/v1/devices/ Optional

Next steps

For more information, see the Defender for IoT API reference overview.