Huntress icon

Huntress

Interact with Huntress API

Actions86

Agents → List Agents

AI-generated

Summary

Lists Huntress agents through the Agents API, with optional filters and configurable pagination. Use Return All to fetch multiple pages; otherwise the node makes a single-page request.

Inputs

  • Return All — When enabled, fetches all available pages. When disabled, sends no pagination parameters and returns one page.
  • Limit — Maximum resources per page; declared default is 10, with a minimum of 1 and maximum of 500.
  • Page Token — Token for requesting the next page; defaults to an empty value.
  • Sort Field — Sort by ID, creation time, or update time; defaults to ID.
  • Sort Direction — Sort ascending or descending; defaults to descending.
  • Organization Id — Filter agents by organization ID.
  • Platform — Filter by Windows, Darwin, or Linux; the declared default is Windows.
  • Hostname — Filter by hostname.
  • Os — Filter by operating system.
  • Version — Filter by agent version.
  • Custom Body — Optional JSON merged with the request fields; custom body values take priority.
  • Custom Headers — Optional HTTP headers to send with the request.
  • Query Filters — Additional query-string parameter names and values.
  • Batching — Configures grouping of input items and the delay between batches.
  • Debug — When enabled, adds the request URL, query parameters, headers, and body to the output under a debug entry.
  • Pagination — Configures pagination mode, parameter names, response paths, page size, page limit, and delay between page requests.
  • Timeout (ms) — Time to wait for response headers before aborting; defaults to 300000 ms.

Output shape

A list of agent records, with optional debug information.

The operation’s source pack only shows function and class signatures, so the exact response envelope and pagination behavior beyond the UI declarations cannot be confirmed from the provided source. With Return All disabled, the UI specifies that only one page is returned.

Links

Discussion