control

retrieve the effective configuration

Returns every configuration property with its resolved value and the source tier that supplied it, so an operator can see which of the property file, system properties, environment variables or defaults won. Values detected as sensitive are redacted. Any mockserver.* system property, MOCKSERVER_* environment variable or properties-file key that is not a known property follows, with source unrecognised, value (ignored) and the known properties it was most likely meant to be; the value it was set to is never returned. Distinct from /mockserver/configuration, which reads and writes the mutable runtime configuration.

get/mockserver/config

Request

  • Base URL: http://localhost:1080
  • URL: http://localhost:1080/mockserver/config
  • Auth: none declared

Query parameters

nonDefaultboolean

when true, the properties at their built-in default are left out

Response

effective configuration returned

namestring

the property name, or the unrecognised key as it was set

valuestring

the resolved value (for a property at its built-in default, that default's value), ***REDACTED*** for a credential, (ignored) for an unrecognised key, or (default) only when a default could not be read

source'system-property' | 'properties-file' | 'environment-variable' | 'default' | 'runtime-set' | 'unrecognised'
defaultstring

for a property set away from its built-in default, that default, redacted like the value (always ***REDACTED*** for a credential); absent for a property at its default and when the default cannot be read

setAs'system property' | 'environment variable' | 'properties-file key'

for an unrecognised key, how it was set

suggestionsstring[]

for an unrecognised key, the known properties it was most likely meant to be

systemPropertyOnlyboolean

present and true for a setting read only as a JVM system property that was set in the properties file or the environment instead

Changes

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