Velociraptor icon

Velociraptor

Interact with Velociraptor DFIR platform via gRPC API

Actions8

Get Flow Status

AI-generated

Summary

Retrieve the status of a specific collection flow executed on a Velociraptor client.

Inputs

  • Client ID (required) — Velociraptor client ID (e.g. C.1234567890abcdef).
  • Flow ID (required) — Flow ID returned by Collect Artifact or Collect VFS File (e.g. F.C123456).

Output shape

a single JSON object representing the flow status or a 'NOT_FOUND' status if the flow does not exist

Returns flow state, total collected rows, total uploaded files, and backtrace info; includes client_id and flow_id fields. If the flow is not found, returns JSON with state set to 'NOT_FOUND'.

Examples

Example 1: Checking the current progress and state of a Velociraptor collection flow for a given client.

Provide the Client ID and Flow ID to fetch the flow's status information.

Links

Discussion