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.

Configuring silent log detection using the API

Prev Next

Devices such as Network Security appliances, Email Security - Server appliances, Endpoint Security (HX) servers, Packet Capture appliances, Comm Broker, and Cloud Collector send logs to Helix. Silent log detection notifies device users when their devices stop sending logs or when logging volume falls below a defined threshold value.

Note

Silent log detection is not supported for events received directly from cloud sources, such as Amazon Web Services (AWS) Lambda.

The check for silent log detection is performed every hour. You can define threshold durations by second (s), minute (m), or hour (h). For Helix instances operating under Trellix IAM, you must generate a Trellix API token to manage silent log detection via the API.

Important

The API endpoint URLs used in the examples below ( apps.fireeye.com ) are for the US region. You must replace this URL with your specific regional endpoint (e.g., helix.ap.fireeye.com ). Using an incorrect regional endpoint will result in a 401 Unauthorized error.

To configure silent log detection:  

  1. Obtain the list of device IPs
    Use the following TQL query in the Helix Web UI to get a list of IPv4 addresses for devices currently sending logs.

    groupby meta_sip4
  2. Create the configuration CSV file
    Create a CSV file containing your desired sender configurations. The CSV file must contain the exact columns listed below.

    • device name: A custom string you choose to identify the device.

    • device_ipv4: The IPv4 address of the device sending logs.

    • threshold_eps: The minimum events per second (EPS) expected from the device.

    • email_recipients: A comma-separated list of email addresses to notify if the threshold is not met.

    • duration: The time period to measure against (for example, 10s, 5m, 1h).

  3. Generate a Trellix API Token
    To authenticate your API requests, generate a Trellix IAM Bearer token using your client credentials. You can use any valid Helix scope (for example, scope=hlx.org.adm).

    curl --location "https://iam.cloud.trellix.com/iam/v1.0/token" \
    --header "Authorization: Basic <base64-encoded client_id:client_secret>" \
    --header "content-type: application/x-www-form-urlencoded" \
    --data-urlencode "scope=hlx.org.adm" \
    --data-urlencode "grant_type=client_credentials"
  4. Upload the sender CSV file
    Use the generated Bearer token to upload your CSV file to your Helix instance.

    curl -X POST -F "file=@<path to your csv file>" \
    --location "https://apps.fireeye.com/helix/id/<Helix ID>/api/v3/senders" \
    --header "x-trellix-api-token: Bearer <Token from step 3>"
  5. Enable silent log detection
    Execute a PUT request to enable the detection feature.

    curl -X PUT \
    --location "https://apps.fireeye.com/helix/id/<Helix ID>/api/v3/senders/enable" \
    --header "x-trellix-api-token: Bearer <Token from step 3>"
  6. Confirm silent log detection status
    Execute a GET request to verify that silent log detection is successfully enabled.

    curl -X GET \
    --location "https://apps.fireeye.com/helix/id/<Helix ID>/api/v3/senders" \
    --header "x-trellix-api-token: Bearer <Token from step 3>"
  7. Disable silent log detection
    If you need to disable silent log detection, execute a DELETE request against the enable endpoint.

    curl -X DELETE \
    --location "https://apps.fireeye.com/helix/id/<Helix ID>/api/v3/senders/enable" \
    --header "x-trellix-api-token: Bearer <Token from step 3>"