bregctl statistics withdraw command reference
Withdraw one immutable statistical release version.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.40.0 and catalog SHA-256 42b4f89103fb6b0fc57282f99a8d8ab8fc777b3c745d6243720ff4a99ba1f57f. Hidden implementation commands are omitted.
bregctl statistics withdraw [OPTIONS] --breg-url <URL> --access-token-file <ABSOLUTE_FILE> --dataset <ID> --period <PERIOD> --version <NUMBER> --reason <REASON> --profile <ID> --idempotency-key <KEY>Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--breg-url <URL> | Yes | n/a | n/a | n/a | Base Registry Engine base URL. HTTP is accepted only for loopback hosts |
--access-token-file <ABSOLUTE_FILE> | Yes | n/a | n/a | n/a | Absolute file containing one bearer access token and no other credential material. A symbolic link at any component of this path is refused. |
--dataset <ID> | Yes | n/a | n/a | n/a | Compiled statistical dataset identifier |
--period <PERIOD> | Yes | n/a | n/a | n/a | Statistical period code containing the version |
--version <NUMBER> | Yes | n/a | n/a | n/a | Positive immutable release version to withdraw |
--reason <REASON> | Yes | n/a | computation-error, source-data-error, disclosure-risk | n/a | Closed reason recorded with the withdrawal |
--profile <ID> | Yes | n/a | n/a | n/a | Compiled publisher access profile identifier |
--idempotency-key <KEY> | Yes | n/a | n/a | n/a | Caller-owned idempotency key for this exact withdrawal request |
--format <FORMAT> | No | human | human, json | n/a | Emit the selected command’s report in this format |
-h, --help | No | n/a | n/a | n/a | Print help |
Generation contract
Section titled “Generation contract”Run npm run generate from docs/site after changing a public command, argument, option, default, environment binding, or help description.