The new docs.trellix.com features a modernized UI and AI-powered conversational search. Content is currently available in English, with additional languages expected in November 2026. We hope you enjoy the updated experience.

Sensor

Prev Next
S.No Request URI Actions Allowed Actions Performed
1 /sensors?domain=<domain_id> GET Get the list of Sensors available in the specified domain

If the domain is not specified, details of all the Sensors in all ADs will be provided

2 /sensor/<sensor_id> GET Get details for the specified Sensor
3 /sensor/<sensor_id>/action/update_sensor_config PUT Perform configuration update for the specified Sensor
4 /sensor/<sensor_id>/action/update_sensor_config/<request_id> GET Get the configuration update status for the specified request id
5 /sensor/<sensor_id>/action/update_sensor_config GET Provides the info whether Sensor configuration has been changed and configuration update is pending to the Sensor. The configuration change details are provided as well.
6 /sensor/<sensor_id>/performancestats?metric=<metric>&portId=<port_id> GET Provides performance stats for the specified Sensor, metric and port Id
7 /sensor/<sensor_id>/action/reboot PUT Reboot the specified Sensor
8 /sensor/<sensor_id>/ipv6 POST Drop/Pass/Scan IPv6 on the specified Sensor
9 /sensor/<sensor_id>/ipv6 GET Provides the IPv6 setting (Drop/Pass/Scan) set on the specified Sensor
10 /sensor/<sensor_id>/status GET Provides the Sensor status “Active”/”Disconnected”
11 sensor/<sensor_id>/policy/applicationidentification GET Get application identification
12 sensor/<sensor_id>/policy/applicationidentification PUT Update application identification
13 sensor/<sensor_id>/ntbaintegration GET Get NTBA integration configuration
14 sensor/<sensor_id>/ntbaintegration PUT Update NTBA integration configuration
15 sensor/<sensor_id>/deploydevicesoftware GET Get device software's deployed
16 sensor/<sensor_id>/deploydevicesoftware/<swVersion> PUT Upgrade the software on device
17 sensor/<sensor_id>/ deploydevicesoftware/<requestId> GET Get the upgrade software status