oz0 retention hold

Place a legal hold: nothing of the tenant is deleted or erased until it is released.

For: Operators and developers looking up a command.

Place a legal hold: nothing of the tenant is deleted or erased until it is released. A hold a cluster admin placed only a cluster admin may release. While it holds, the edge copies each closed job's Temporal history, as Temporal holds it, into the database before Temporal's retention deletes it (oz0 retention held lists the copies); releasing the hold lets the copies go at the next retention pass.

Usage

oz0 retention hold [flags]

Flags

FlagTypeDefaultDescription
--decision-refstringthe decision or case the change follows, such as a case number (at most 200 characters)
--jsonboolprint JSON instead of a table
--reasonstringwhy the data is held, such as the case it is for (required)

Inherited flags

FlagTypeDefaultDescription
--contextstring$OZ0_CONTEXT or <config dir>/orchestrator-zero/context.jsonCLI context file written by server init
--log-levelstringinfolog level: debug, info, warn or error
--tenantstringdefaultthe tenant

See all oz0 commands and the global flags.

On this page
Copyright © 2026