Edit

Share via


Inventory management API reference for on-premises management consoles

This article lists the inventory management REST APIs supported for Microsoft Defender for IoT on-premises management consoles

devices (Retrieve all device information)

This API requests a list of all devices detected by Defender for IoT sensors that are connected to an on-premises management console.

URI: /external/v1/devices

GET

Query parameters:

Name Description Example Required / Optional
authorized Boolean. Filters by whether the device is authorized or not. /external/v1/devices?authorized=true

/external/v1/devices?authorized=false
Optional
siteId Comma separated list of long integers. Filter devices for specified sites by site ID. /external/v1/devices?siteId=1,2 Optional
zoneId Comma separated list of long integers. Filter devices for specified zones by zone ID. /external/v1/devices?zoneId=5,6 Optional
sensorId Comma separated list of long integers. Filter devices for specified sensors by sensor ID. /external/v1/devices?sensorId=8 Optional

Tip

If you don't have a site, zone, or sensor ID, query all devices first to retrieve these values.

Next steps

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