Skip to main content
Version: v5.6.1

opschain admin settings show

Included from Basic tier

Shows the stored global settings document: the CLI resolves the system configuration's settings document over the v2 API (SystemConfigurationService.GetSystemConfiguration, then the settings read) — the same lookup the GUI makes — and prints the document id, its version, when that version was created, and the full settings data as JSON. A pruneable line appears when the data still carries legacy Rails-era keys the Go server does not read, naming them and pointing at opschain admin settings prune.

--version N shows that version from the document's history instead of the current one — which is also how anything a prune removed is recovered, since every write preserves its predecessor. The version shown is the settings document's own version counter, not the server version.

The verb authenticates as the ordinary logged-in user and requires a server target (--server <url>, OPSCHAIN_SERVER, or the active context).

Flags​

FlagMeaning
--version <n>Show this version from the document's history instead of the current one.

-o json|yaml prints id, version, creation time, data and the pruneable keys as one machine document.

Exit codes​

CodeMeaning
0Document shown.
1The request failed, the document could not be decoded, or the server carries no settings reference.
2Usage error — no server target.

Named errors​

  • stored settings documents live on a server's nodes — pass --server <url> or 'opschain context use <name>' — no server target (exit 2).
  • the system configuration carries no settings document reference — the server's system configuration names no stored document (exit 1).

Examples​

opschain admin settings show
opschain admin settings show --version 3

See also​

  • opschain docs cli/admin-settings-prune — act on the pruneable line.