CLI Reference

c8volt cancel process-instance

Cancel process instance(s) by key or search filters and wait for completion

c8volt cancel process-instance [flags]

Examples 

  ./c8volt cancel pi --key 2251799813711967
  ./c8volt cancel pi --key 2251799813711977 --force
  ./c8volt cancel pi --state active --start-date-before 2026-03-31
  ./c8volt cancel pi --state active --start-date-newer-days 30
  ./c8volt cancel pi --bpmn-process-id order-process --start-date-after 2026-01-01 --start-date-before 2026-01-31
  ./c8volt cancel pi --bpmn-process-id order-process --start-date-older-days 14 --state active
  ./c8volt cancel pi --end-date-after 2026-01-01 --end-date-before 2026-01-31 --state completed
  ./c8volt get pi --state active --bpmn-process-id C88_SimpleUserTask_Process --keys-only | ./c8volt cancel pi -

Options 

  -b, --bpmn-process-id string      BPMN process ID to filter process instances
      --end-date-after string       only include process instances with end date >= YYYY-MM-DD
      --end-date-before string      only include process instances with end date <= YYYY-MM-DD
      --end-date-newer-days int     only include process instances with end date N days old or newer (0 means today) (default -1)
      --end-date-older-days int     only include process instances with end date N days old or older (default -1)
      --fail-fast                   stop scheduling new instances after the first error
      --force                       force cancellation of the root process instance if a process instance is a child, including all its child instances
  -h, --help                        help for process-instance
  -k, --key strings                 process instance key(s) to cancel
      --no-state-check              skip checking the current state of the process instance before cancelling it
      --no-wait                     skip waiting for the cancellation to be fully processed
      --no-worker-limit             disable limiting the number of workers to GOMAXPROCS when --workers > 1
      --pd-version int32            process definition version
      --pd-version-tag string       process definition version tag
      --start-date-after string     only include process instances with start date >= YYYY-MM-DD
      --start-date-before string    only include process instances with start date <= YYYY-MM-DD
      --start-date-newer-days int   only include process instances N days old or newer (0 means today) (default -1)
      --start-date-older-days int   only include process instances N days old or older (default -1)
  -s, --state string                state to filter process instances: all, active, completed, canceled (default "all")
      --with-age                    include process instance age in one-line output and JSON meta
  -w, --workers int                 maximum concurrent workers when --count > 1 (default: min(count, GOMAXPROCS))

Options inherited from parent commands 

  -y, --auto-confirm               auto-confirm prompts for non-interactive use
      --backoff-max-retries int    max retry attempts (0 = unlimited)
      --backoff-timeout duration   overall timeout for the retry loop (default 2m0s)
      --config string              path to config file
      --debug                      enable debug logging, overwrites and is shorthand for --log-level=debug
  -j, --json                       output as JSON (where applicable)
      --keys-only                  output as keys only (where applicable), can be used for piping to other commands
      --log-format string          log format (json, plain, text) (default "plain")
      --log-level string           log level (debug, info, warn, error) (default "info")
      --log-with-source            include source file and line number in logs
      --no-err-codes               suppress error codes in error outputs
      --profile string             config active profile name to use (e.g. dev, prod)
  -q, --quiet                      suppress all output, except errors, overrides --log-level
      --tenant string              default tenant ID
  -v, --verbose                    adds additional verbosity to the output, e.g. for progress indication

SEE ALSO