List Sensor Details
Get a list of sensors with appliance information and statuses.
Offset pagination parameter used to exclude from a response the first N items of a resource collection. Combine the limit 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 param to filter by display name.
Use this request param to filter by sensor registration status. The valid values are 'registered', 'in_progress', and 'failed'.
Use this request param to filter by sensor registration status. The valid values are 'ok', 'disconnected', and 'degraded'.
Set to true when filtering sensors that have flow event reporting enabled. Valid values are 'true' or 'false'.
Set to true when filtering sensors that have MPS (malware) event reporting enabled. Valid values are 'true' or 'false'.
Set to true when filtering sensors that have IDS event reporting enabled. Valid values are 'true' or 'false'.
Set to true when filtering sensors that have packet capturing enabled. Valid values are 'true' or 'false'.
OK
{
"offset": 0,
"number_of_results": 0,
"total_result_count": 0,
"total_pages": 0,
"sort_ascending": false,
"sort_by": "string",
"results": [
{
"sensor_info": {
"token_id": "string",
"certificate": "string",
"pem_encoded": "string",
"algorithm": "string",
"key_size": 0
},
"appliance_info": {
"cpu_sockets": 0,
"cpu_cores": 0,
"memory": 0,
"software_version": "string"
},
"appliance_networking_info": {
"host_name": "string",
"nics": [
{
"mac_address": "string",
"ipv4_address": "string",
"ipv6_address": "string",
"is_mgmt": false
}
],
"dns": [
"string"
],
"ntp": [
"string"
],
"home_networks": [
"string"
]
},
"appliance_ids_signature_info": {
"bundle_id": "string",
"ids_signature_bundle_version": "string",
"number_of_signatures": 0,
"_last_modified_time": 0
},
"sensor_feature_config": {
"ids_enabled": false,
"ids_config": {
"pcap_enabled": false
},
"flows_enabled": false,
"mps_enabled": false,
"mps_config": {
"document_file_type": false,
"executable_file_type": false,
"media_file_type": false,
"archive_file_type": false,
"data_file_type": false,
"script_file_type": false,
"other_file_type": false
}
},
"sensor_status": {
"registration_status": "string",
"health": "string",
"sniffing_health": "string",
"uploading_health": "string",
"rapid_health": "string",
"uptime": 0,
"_last_modified_time": 0
}
}
]
}Error
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
curl -H 'Authorization: <value>' https://{api_host}/sensors/appliances/details