hunt_idHunt ID to export.string (required)
only_combinedIf set we only export combined results.bool
waitIf set we wait for the download to complete before returning.bool
formatFormat to export (csv,json) defaults to both.string
baseBase filename to write to.string
passwordAn optional password to encrypt the collection zip.string
expand_sparseIf set we expand sparse files in the archive.bool

Required Permissions: PREPARE_RESULTS


Creates a download pack for a hunt.

This function initiates the download creation process for a hunt. It is equivalent to the GUI functionality allowing to “Download Results” from the Hunts Overview page.

Using the wait parameter you can wait for the download to complete or just kick it off asynchronously.