| title | c8volt update process-instance |
|---|---|
| nav_exclude | true |
[CLI Reference]({{ "/cli/" | relative_url }})
Update process-instance variables by key
Update process-instance-scope variables on Camunda 8.8 or newer.
Provide repeated --key values or newline-separated keys from stdin with '-'. Supply exactly one payload source: --vars with a JSON object or --vars-file with its file path. The same variable map is applied to every unique key. Explicit keys use backend authorization without tenant filtering.
c8volt reads every selected process instance's complete root-variable scope before planning additions and changes. Nested-scope variables are excluded, and truncated values remain planned changes because they cannot prove equality. After confirmation, the command writes only the prepared additions and changes locally to their recorded roots, then waits until all requested variables are visible through the same lookup as get process-instance --with-vars. Detailed previews label every planned write with its selected process-instance root as pi:.
Use --dry-run to inspect changes without mutation, or --auto-confirm for unattended updates. A completed plan with no additions or changes finishes without confirmation, mutation, or verification. Use --no-wait to return after accepted root writes without confirmation. Partial failures retain accepted, failed, and skipped outcomes while returning a nonzero exit status.
c8volt update process-instance [flags]
./c8volt update process-instance --key <process-instance-key> --vars '{"customerTier":"gold"}' --dry-run
./c8volt update process-instance --key <process-instance-key> --vars-file ./vars.json --dry-run
./c8volt --tenant tenant-a update process-instance --key <process-instance-key> --vars '{"customerTier":"gold"}' --dry-run
./c8volt update process-instance --key <process-instance-key-a> --key <process-instance-key-b> --vars '{"customerTier":"gold"}' --dry-run
printf '%s\n' "$PROCESS_INSTANCE_KEY_A" "$PROCESS_INSTANCE_KEY_B" | ./c8volt update process-instance - --vars '{"customerTier":"gold"}' --dry-run
./c8volt --json update process-instance --key <process-instance-key> --vars '{"customerTier":"gold"}' --dry-run
--dry-run preview variable updates without submitting mutation
--fail-fast stop scheduling new updates after the first error
-h, --help help for process-instance
-k, --key strings process instance key(s) to update; repeat or combine with stdin '-'
--no-wait return after the update request is accepted without variable confirmation
--no-worker-limit use all queued jobs as workers when --workers is unset
--vars string JSON object with variables to set on each process instance
--vars-file string path to JSON object file with variables to set on each process instance
-w, --workers int maximum concurrent workers when updating multiple process instances (default: min(count, 2*GOMAXPROCS, 32))
--all-tenants clear configured tenant filtering and search all tenants visible to the authenticated user; mutually exclusive with --tenant
-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
--request-rate float maximum shared request starts per second (fractions allowed; 0 disables pacing)
--tenant string tenant ID for discovery/search, selection, create, deploy, and run flows; explicit empty values can clear configured discovery filters, and explicit keys/IDs remain backend-authorized
--timeout duration HTTP request timeout (default 30s)
-v, --verbose show additional output
- [c8volt update]({{ "/cli/c8volt_update" | relative_url }}) - Update existing resources