List Sensor Details
Get a list of sensors with appliance information and statuses. | Sorting is supported by the following fields - display_name, registration_status, health, flows_enabled, | mps_enabled, ids_enabled, and pcap_enabled.
Offset pagination parameter used to exclude from a response the first N items of a resource collection. Combine the offset and the page_size options to request a particular set or page of items.
Number of records to be returned in the API request from the provided offset
True, if the list of records returned need to be sorted in ascending order, false otherwise.
The parameter name on which to sort the list of records. Only top-level parameters in the returned list of records will be supported. If not provided, system will define the parameter by which results are sorted.
Use this request parameter to filter by display name.
sensorUse this request param to filter by sensor registration status. The valid values are 'registered', 'in_progress', and 'failed'.
registeredUse this request param to filter by sensor registration status. The valid values are 'ok', 'disconnected', and 'degraded'.
okSet to true when filtering sensors that have flow event reporting enabled. Valid values are 'true' or 'false'.
trueSet to true when filtering sensors that have MPS (malware) event reporting enabled. Valid values are 'true' or 'false'.
trueSet to true when filtering sensors that have IDS event reporting enabled. Valid values are 'true' or 'false'.
trueSet to true when filtering sensors that have packet capturing enabled. Valid values are 'true' or 'false'.
trueUse this request param to filter by a list of sensor appliance ids.
8c147e21-7410-4f77-a3a6-e7aa6034992fUse this request param to filter by sensor software version. Pass one or more values; multiple values are combined with OR (a sensor matches if any entry matches). Each entry supports the same syntax as a single filter: wildcard patterns using '' (e.g., '5.', '5.2.'), exact dotted versions, or comparison operators '<' or '>' before a numeric version string (e.g., '<5.2', '>3.1'). A comparison entry must not contain ''. Version filter entries require at least major.minor (e.g., '5.2'). Supports 2-part to 6-part targets, for example '>6.0.0' or '6.0.0.0.0.1'. Note: >5.2 compares against 5.2.0.0.0.0 because unspecified parts are defaulted to 0.
5.2OK
{
"number_of_results": 1,
"offset": -1,
"results": [
{
"appliance_ids_signature_info": {
"_last_modified_time": 1778683127642,
"bundle_id": "ac658667-db5d-4e67-b8b8-1b341bdc9a82",
"ids_signature_bundle_version": "2000",
"number_of_signatures": 10000
},
"appliance_info": {
"cpu_cores": 1,
"cpu_sockets": 12,
"memory": 32,
"software_version": "5.2.0.0.0.25398843"
},
"appliance_networking_info": {
"dns": [
"172.16.111.1"
],
"home_networks": [
"10.0.0.0/8",
"172.16.0.0/12",
"192.168.0.0/16",
"169.254.0.0/16",
"fc00::/7",
"fe80::/10"
],
"host_name": "ndr-sensor-8c147e21",
"nics": [
{
"ipv4_address": "",
"ipv6_address": "",
"is_mgmt": false,
"mac_address": "00:50:56:ab:26:24"
},
{
"ipv4_address": "172.16.111.133",
"ipv6_address": "",
"is_mgmt": true,
"mac_address": "00:50:56:ab:d0:36"
}
],
"ntp": [
"172.16.111.1"
]
},
"sensor_feature_config": {
"flows_enabled": true,
"ids_config": {
"pcap_enabled": false
},
"ids_enabled": true,
"mps_config": {
"archive_file_type": true,
"data_file_type": true,
"document_file_type": true,
"executable_file_type": true,
"media_file_type": true,
"other_file_type": true,
"script_file_type": true
},
"mps_enabled": false
},
"sensor_info": {
"_create_time": 1778683578561,
"_create_user": "ndr-sensor",
"_last_modified_time": 1778683581215,
"_revision": 1,
"algorithm": "RSA",
"certificate": "-----BEGIN CERTIFICATE----- xxxxx -----END CERTIFICATE-----",
"description": "Token for ndr sensor",
"display_name": "sensor",
"id": "8c147e21-7410-4f77-a3a6-e7aa6034992f",
"key_size": 3072,
"pem_encoded": "xxxxx",
"token_id": "b93a7903-3a7d-4dfa-b6fc-4d17e0e4707c"
},
"sensor_status": {
"_last_modified_time": 1778684806988,
"health": "OK",
"rapid_health": "DISABLED",
"registration_status": "REGISTERED",
"sniffing_health": "OK",
"uploading_health": "OK",
"uptime": 36782390
}
}
],
"total_pages": 1,
"total_result_count": 1
}Bad Request
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Unauthorized
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Forbidden
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Failed
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Required
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Too Many Requests
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Error
{
"error_code": 0,
"module_name": "sensor",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
This operation contains the following vendor extensions defined in the spec:
["platform-sensor-all"]
curl -H 'Authorization: <value>' https://{api_host}/sensors/appliances/details