Huntress icon

Huntress

Interact with Huntress API

Actions86

PlatformActions → List Platform Actions

AI-generated

Summary

Retrieve a list of platform actions from the Huntress API with optional filters and pagination controls.

Inputs

  • Return All — Set to true to retrieve all pages of platform actions; if false, retrieves only one page as specified by pagination parameters.
  • Additional Fields — Configure filters such as limit, status, severity, subtype, organization ID, sorting (field and direction), and pagination tokens to narrow or sort the results.
  • Options — Customize the request by providing a custom JSON body, adding custom headers, query filters, batching settings, enabling debug output, and detailed pagination configuration including pagination mode, page parameter names, cursor paths, and limits.

Output shape

a list of platform action items from the Huntress API, optionally paginated and filtered based on input parameters

The output may include debug information with the actual request details if enabled. Pagination can be handled automatically when 'Return All' is true or controlled via pagination settings. Sorting and filtering parameters refine the returned results. Default page size is 10 items if not otherwise specified.

Examples

Example 1: List the first page of open platform actions with severity 'low', sorted by ID descending.

Return All: false; Additional Fields: status=open, severity=low, limit=10, sort_field=id, sort_direction=desc.

Links

Discussion