Huntress icon

Huntress

Interact with Huntress API

Actions86

Signals → Get Signal

AI-generated

Summary

Retrieve detailed information about a specific Huntress signal by its unique Signal ID.

Inputs

  • id (required) — Numeric identifier of the signal within the Huntress account to fetch.
  • options.customBody — Optional JSON object to send as a custom body, merged with other parameters, allowing override of default request fields.
  • options.headerFilters — Optional set of custom HTTP headers to include in the request.
  • options.queryFilters — Optional query-string filters to modify or refine the API request parameters.
  • options.batching — Configuration for batching input items into groups, controlling batch size and interval between batches to manage rate limits.
  • options.debug — Flag to include detailed debug information about the HTTP request (URL, headers, body) in the output for troubleshooting.
  • options.pagination — Settings for pagination behavior, though pagination is generally not applicable for single signal retrieval.
  • options.timeout — Timeout in milliseconds to wait for the server's response before aborting the request. Defaults to 300000 ms (5 minutes).

Output shape

a single JSON object representing the requested Signal's details as returned by the Huntress API

The output includes the full data of the specified signal. If debug is enabled, the output will also contain diagnostic information about the HTTP request. Pagination settings have limited effect as the operation fetches a single resource by ID. Errors will be thrown if the ID is invalid or API request fails.

Links

Discussion