Huntress icon

Huntress

Work with the Huntress API

Actions11

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 analyze agents managed within an organization, such as inventory management, monitoring agent platforms, or auditing organizational assets.

For example, you can use this node to:

  • Fetch all agents belonging to a specific organization.
  • Retrieve agents filtered by their operating system platform (Windows or Mac OS).

Properties

Name Meaning
Filters A collection of optional filters to narrow down the agents retrieved:
- Organization ID Numeric ID representing the organization to filter agents by.
- Platform Operating system platform of the agents; options are "Windows" or "Mac OS".

Output

The node outputs JSON data containing an array of agent objects matching the applied filters. Each agent object typically includes details such as agent ID, organization ID, platform, and other metadata provided by the Huntress API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Huntress API.
  • The node makes HTTP requests to https://api.huntress.io/v1.
  • Pagination support is included via internal utility functions to handle large result sets.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an invalid organization ID or platform value may result in empty results or errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • Authentication errors typically indicate incorrect or expired API keys; verify and update credentials.
    • HTTP status codes returned from the API (e.g., 400, 401, 404) should be checked for detailed error causes.
    • If no agents are returned, confirm that the filters match existing data.

Links and References

Discussion