System Admin

Get a single system setting by key

Changed on

Returns the row matching :key. 404 when the key is unknown to the registry; 200 with the row when known.

get/system/admin/settings/{key}

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/system/admin/settings/{key}
  • Auth
    none declared

Path parameters

keystring required

Setting key (e.g. file.max_size_mb)

Response

the setting row

categorystring

Category groups settings in the management UI ("limits", "agent", "auth", ...). Free-form string so adding a new category is a data-only change.

created_atstring
descriptionstring
enumstring[]

Enum is populated by the service layer (NOT persisted) from the in-code registry. Empty/nil means "free-form input"; non-empty means the UI should render a select with these options. Tagged gorm:"-" so GORM never tries to read/write the column.

idinteger
is_secretboolean

IsSecret reserves UI affordances for P3 (mask + reveal-with-confirm). In P1 every row is is_secret=false; service Update accepts the column but does not yet enforce special handling.

keystring
last_modified_bystring
last_modified_by_namestring

LastModifiedByName is a display label resolved from LastModifiedBy (the user's UUID) at handler time — username when available, otherwise email. Empty for virtual rows that were never persisted (LastModifiedBy=""). Not stored: derived per request so renaming a user reflects on the next reload without a backfill job.

requires_restartboolean

RequiresRestart reserves UI affordances for P3 (banner "this change won't take effect until the next restart"). In P1 the only seeded key is per-request, so always false.

updated_atstring
valueobject
value_typestring

ValueType is one of "int", "string", "bool". Service layer rejects updates whose payload type does not match; UI uses it to pick InputNumber vs Input vs Switch.

Changes