Huntress icon

Huntress

Interact with Huntress API

Actions86

KnownVPNs → List Known VPNs and Proxies

AI-generated

Summary

Retrieve a list of known VPN and proxy IP addresses from the Huntress API, with options to paginate and filter results.

Inputs

  • returnAll — Set to true to fetch all pages of known VPNs and proxies; false to fetch only one page.
  • options.customBody — Provide a custom JSON object with arbitrary parameters to include in the request body, which will override other request parameters.
  • options.headerFilters — Specify custom HTTP headers to send with the API request.
  • options.queryFilters — Set query-string filters as key-value pairs to refine the API request parameters.
  • options.batching — Configure batch processing settings including number of items per batch and wait interval between batches.
  • options.debug — Enable to include detailed debug information about the HTTP request made, helpful for troubleshooting.
  • options.pagination — Adjust pagination behavior such as mode (offset, cursor, or URL-based), page size, start values, and maximum pages to retrieve.
  • options.timeout — Specify maximum time in milliseconds to wait for the server's response before aborting the request.

Output shape

a list of objects representing known VPNs and proxies as returned by the Huntress API

Supports full pagination according to configured pagination options. When debug is enabled, output includes request detail metadata under a debug entry. Custom body and header options override default request options.

Links

Discussion