Sign in
Settings

Get a specific global setting

Changed on

Returns a single global setting with its source

get/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/settings/{key}
  • Auth: API key in header Cookie

Path parameters

keystring required

Setting key

Response

OK

env_varstring

e.g., "RGW_SETTING_MFA_REQUIRE_ALL_USERS"

source'db' | 'env' | 'default' | 'global_default'
stored_value_ignoredboolean

StoredValueIgnored reports a database value that the environment variable overrides. It has no effect, and can be cleared.

valueunknown

Changes