oz0 retention held
For: Operators and developers looking up a command.
While a legal hold holds, the edge copies each closed job's Temporal history into the database before Temporal's retention deletes it, as Temporal holds it: encrypted with the tenant's key when payloads are encrypted, as they are by default in a cluster. Each copy is an audit entry (retention.hold.copied). Without --job it lists them, for the tenant's admins.
With --job and --run it downloads one into the folder --out: history.json, Temporal's JSON history (what temporal workflow show --output json writes, and what the SDKs' replayers read), and the External Storage payloads it refers to under payloads/, which needs the content permission and is an audit entry. Large retained copies download in bounded verified parts into a new or empty directory.
--captures shows pending, partial and failed preservation with its retry timing, so missing content is not mistaken for a complete copy. Payloads decode through the edge's codec endpoint for those who may see them.
Usage
oz0 retention held [flags]
Flags
| Flag | Type | Default | Description |
|---|---|---|---|
--captures | bool | list preservation progress and failures, without job content (at most 128 per page) | |
--job | string | the job whose copy to download | |
--json | bool | print JSON instead of a table | |
--limit | int32 | 100 | list at most this many, newest close first |
--out | string | the output folder; choose a private parent because temporary files are staged beside it | |
--page-token | string | with --captures, continue from the previous page's token | |
--run | string | its run, as the list names it |
Inherited flags
| Flag | Type | Default | Description |
|---|---|---|---|
--context | string | $OZ0_CONTEXT or <config dir>/orchestrator-zero/context.json | CLI context file written by server init |
--log-level | string | info | log level: debug, info, warn or error |
--tenant | string | default | the tenant |
See all oz0 commands and the global flags.