Huntress icon

Huntress

Work with the Huntress API

Actions9

Overview

This node integrates with the Huntress API to retrieve multiple Agent records based on specified filters. It is useful for scenarios where you need to list or query agents managed by Huntress, such as inventory management, monitoring agent status across an organization, or generating reports filtered by organizational units or platforms.

For example, you can use this node to:

  • Fetch all agents belonging to a specific organization.
  • Retrieve agents running on a particular platform like Windows or Mac OS.
  • Combine filters to narrow down the agent list for targeted analysis or automation workflows.

Properties

Name Meaning
Filters A collection of optional filters to refine the list of agents returned by the API.

Inside Filters:

Name Meaning
Organization ID Numeric identifier to filter agents by their associated organization.
Platform Operating system platform filter; options are "Windows" or "Mac OS".

Output

The node outputs JSON data representing an array of agent objects retrieved from the Huntress API. Each object contains details about an individual agent, such as its ID, platform, organization association, and other metadata provided by the API.

No binary data output is produced by this node.

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 application/json.

Troubleshooting

  • Common issues:

    • Invalid or missing API authentication token will cause authorization errors.
    • Incorrect filter values (e.g., non-numeric organization ID) may result in empty responses or API errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

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

  • Resolution tips:

    • Verify that the API key credential is correctly configured and has necessary permissions.
    • Double-check filter inputs for correct types and valid values.
    • Ensure network access to api.huntress.io is not blocked by firewalls or proxies.

Links and References

Discussion