Docs menu · Reference

Returns one sanitized configuration value from the allowlist by key, or a null value when the key is not recognized. Only allowlisted, non-sensitive keys are served; an empty key is rejected with invalid_argument.engine.config_key.

Optional reads distinguish present data from missing data. When version or timestamp facts exist on the executor output, SDK mappings should preserve them.

Examples

Read one configuration value by key, or nothing if unknown.

CLI

$ strata config get-key missing

Wire

{"key":"missing","type":"configure_get_key"}

Parameters

NameTypeRequiredDescription
keystringyesConfig key.

Returns

Maybe<String> — a miss returns nothing rather than raising.

Errors

Invocation

  • CLI: strata config get-key
  • Wire type: configure_get_key

agents: this page as markdown → /docs/reference/admin/config_key.md