Huntress icon

Huntress

Work with the Huntress API

Actions9

Overview

The node integrates with the Huntress API to retrieve multiple summary reports based on specified filters. It is designed to fetch aggregated data summaries such as monthly, quarterly, or yearly reports for an organization. This node is useful in scenarios where users want to analyze security or operational metrics over different time periods, enabling trend analysis and reporting.

For example, a security analyst could use this node to pull all monthly summary reports for a particular organization to review recent activity trends or compliance status.

Properties

Name Meaning
Filters A collection of filter options to narrow down the summary reports retrieved:
- Organization ID Numeric identifier specifying which organization's reports to fetch.
- Type The type of summary report to retrieve. Options include: "Monthly", "Quarterly", "Yearly".

Output

The node outputs JSON data containing an array of summary reports matching the provided filters. Each item in the output typically includes details relevant to the summary period (month, quarter, or year) and associated metrics or aggregated data from the Huntress platform.

No binary data output is indicated by the source code.

Dependencies

  • Requires an active connection to the Huntress API.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The base URL for API requests is https://api.huntress.io/v1.
  • Content-Type and Accept headers are set to handle JSON data.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an invalid organization ID or unsupported report type may result in empty responses or errors.
    • Network connectivity issues can prevent successful API calls.

  • Error Messages:

    • Errors returned from the API will include HTTP status codes and messages, e.g., (401) Unauthorized indicating credential problems.
    • The node’s credential test method returns clear success or error messages to help diagnose connection issues.

  • Resolutions:

    • Verify that the API key credential is correctly configured and has necessary permissions.
    • Confirm that the organization ID exists and is correct.
    • Ensure the selected report type matches one of the supported options.
    • Check network access to the Huntress API endpoint.

Links and References

Discussion