Get Device Details per IP Address
Get a list of device details for the device with the specified IP address.
Rate limiting: 60 times per minute
Query Parameters
- customerid string required
The customer ID to which the API call is directed
- ip string required
The IP address of a device for which you want to get details.
- 200
- 4XX
- 5XX
Successful Response (We only show some important fields here.)
- application/json
- Schema
- Example (from schema)
- DeviceDetailPerIPResponseExample
Schema
- deviceid string
The device ID, which IoT Security uses to identify and track a device
- hostname string
The device hostname
- category string
The category to which the device belongs
- profile string
The device profile assigned to the device
- profile_type string
The type of device profile, such as IoT or Non_IoT
- profile_vertical string
The industry vertical for the profile such as Medical, IT Devices, and Office
- ip_address string
The IP address of a device
- mac_address string
The MAC address of a device
- risk_score integer
The risk score of a device
- risk_level string
The risk level of a device. There are four: low, medium, high, and critical
- last_activity date-time
A UTC timestamp for the last detected device activity
- confidence_score string
The confidence score for device classification
- subnet string
The subnet to which the device is attached
- number_of_critical_alerts integer
The number of critical alerts for the device
- number_of_warning_alerts integer
The number of warning alerts for the device
- number_of_caution_alerts integer
The number of caution alerts for the device
- number_of_info_alerts integer
The number of info alerts for the device
- tagIdList array
A list of IDs for user- and system-defined tags assigned to a device
allTags object[]
An array of user-defined tags assigned to a device. Each item in the array consists of three attributes: tagType, tagValue, and tagId.
Array [tagType stringThe key for a user-defined tag
tagValue stringThe value of the tag key for a user-defined tag
tagId stringThe ID of a user-defined tag
]
{
"deviceid": "string",
"hostname": "string",
"category": "string",
"profile": "string",
"profile_type": "string",
"profile_vertical": "string",
"ip_address": "string",
"mac_address": "string",
"risk_score": 0,
"risk_level": "string",
"last_activity": "2023-03-17T18:32:03.798Z",
"confidence_score": "string",
"subnet": "string",
"number_of_critical_alerts": 0,
"number_of_warning_alerts": 0,
"number_of_caution_alerts": 0,
"number_of_info_alerts": 0,
"tagIdList": [
null
],
"allTags": [
{
"tagType": "string",
"tagValue": "string",
"tagId": "string"
}
]
}
{
"deviceid": "34:02:86:44:65:36",
"hostname": "InfusionPump-20",
"category": "Infusion System",
"profile": "Sigma Spectrum Infusion System",
"profile_type": "IoT",
"profile_vertical": "Medical",
"ip_address": "192.168.10.121",
"mac_address": "34:02:86:44:65:36",
"risk_score": 0,
"risk_level": "low",
"last_activity": "2018-05-31T18:39:37.404Z",
"confidence_score": "90",
"subnet": "192.168.10.121/28",
"number_of_critical_alerts": 0,
"number_of_warning_alerts": 0,
"number_of_caution_alerts": 0,
"number_of_info_alerts": 0,
"allTags": [
{
"tagType": "zzzNoTagTypeABC",
"tagValue": "special_blocked",
"tagId": "60f221a219e22f10003a965e"
}
],
"tagIdList": [
"6030135777a1d6fb488e26ad",
"60301332ff1679e9481b62a6",
"602ca12179bc780a2333895d"
]
}
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)
- deviceDetailResponseExample
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."
}