platform-settings

Set a platform-admin setting override

Set an override for a declared setting. Validates the value server-side against the descriptor; an invalid value is REJECTED with 422 -- never coerced (R6). On success the override row is UPSERTed and COMMITTED, THEN the central AuditEvent is emitted (durable row before fail-open emit).

put/api/v1/platform/settings/{key}

Request

  • Base URL: https://api.helena.bio (the document declares no server; this is the origin it was published from)
  • URL: https://api.helena.bio/api/v1/platform/settings/{key}
  • Auth: HTTP bearer

Path parameters

keystring required

Request body

valueunknown required
change_reasonstring nullable

Response

Successful Response

keystring required
servicestring required
config_pathstring required
value_typestring required
defaultunknown required
effective_valueunknown required
applystring required
clinical_relevantboolean required
labelstring required
descriptionstring required
minimumnumber nullable
maximumnumber nullable
is_overriddenboolean
updated_by_user_idstring nullable
updated_by_user_namestring nullable
updated_by_user_emailstring nullable
updated_atstring nullable
change_reasonstring nullable
degrading_consequencestring nullable
degrading_target_valueboolean nullable

Changes

No recorded changes to this operation across all 1 revision of this API.