CLI Reference

c8volt get element

List or fetch runtime element instances

Synopsis

List or fetch Camunda runtime element instances.

Use –key when you know an element instance key. Omit –key to list or search element instances by process instance, BPMN element ID, state, type, process definition, or BPMN process ID.

Search mode follows the shared get paging and limit conventions. –batch-size controls each backend page request, –limit caps returned element rows across all pages, and –total prints only the matching count. Verbose paging progress is written away from stdout; JSON, keys-only, quiet, and automation output remain free of prompts and progress text.

Compact human rows include dur: when start/end timestamps or active state support a runtime duration.

Use –with-listeners to include runtime listener jobs under matching element rows.

Use –json for the stable element payload and –keys-only when piping element instance keys.

Element lookup and search require Camunda 8.8 or 8.9. Camunda 8.7 returns an unsupported-version error.

c8volt get element [flags]

Examples

  ./c8volt get element --key <element-instance-key>
  ./c8volt get element --key <element-instance-key> --with-listeners
  ./c8volt get element --pi-key <process-instance-key> --limit 10
  ./c8volt get element --pi-key <process-instance-key> --with-listeners
  ./c8volt get element --pi-key <process-instance-key> --total
  ./c8volt --json get element --pi-key <process-instance-key> --limit 5
  ./c8volt --json get element --key <element-instance-key> --with-listeners

Options

  -n, --batch-size int32         number of elements to request per page; does not cap total returned rows (max limit 1000 enforced by server) (default 1000)
  -b, --bpmn-process-id string   BPMN process ID to filter in search mode
      --element-id string        BPMN element ID to filter in search mode
  -h, --help                     help for element
  -k, --key string               element instance key for exact lookup; omit to list or search runtime elements
  -l, --limit int32              maximum number of matching elements to return across all pages; omit to continue through all matches
      --pd-key string            process definition key to filter in search mode
      --pi-key string            process instance key to filter in search mode
  -s, --state string             runtime element state to filter in search mode; case-insensitive
      --total                    return only the numeric total of matching elements
      --type string              runtime element type to filter in search mode; case-insensitive
      --with-listeners           include runtime listener jobs under matching element rows

Options inherited from parent commands

  -y, --auto-confirm       auto-confirm prompts for non-interactive use
      --automation         enable non-interactive mode for commands that explicitly support it
      --config string      path to config file
      --debug              enable debug logging
  -j, --json               output as JSON (where applicable)
      --keys-only          output keys only (where applicable)
      --log-level string   log level (debug, info, warn, error) (default "info")
      --no-indicator       disable transient terminal activity indicators
      --profile string     config active profile name to use (e.g. dev, prod)
  -q, --quiet              suppress output except errors
      --tenant string      tenant ID for discovery/search, selection, create, deploy, and run flows; explicit keys/IDs remain backend-authorized
      --timeout duration   HTTP request timeout (default 30s)
  -v, --verbose            show additional output

SEE ALSO

• c8volt get - Inspect cluster, process, job, element, incident, tenant, and resource state