Read the API-set single-value config overlay (root section: listen/tls/rate_card/store/security/limits/…), only the operator's overrides; base config.yaml stands for the rest

Changed on
get/api/v1/admin/config/settings

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header x-admin-token
    • HTTP bearer

Response

{applied:false, config_version, settings} (settings = the current root overrides)

appliedboolean required

true on a PUT that stored + swapped; false on a GET (a pure read).

config_versioninteger required
notestring nullable

A human note describing the live-vs-reload split (absent on a GET).

reload_to_applystring[]

Fields that were stored durably but are RESTART-TO-APPLY: a socket rebind, a TLS acceptor build and a store open all happen once at process start, so a POST /config/reload does NOT make them live; POST /restart (or a supervisor restart) does. Empty when the PUT touched only live-swappable fields (or on a GET). The field NAME is frozen wire; only this description changed.

settingsunknown required

Changes