REST API

Configuration Endpoint

Updated: March 6, 2024

Get a Nuxeo instance's configuration

GET /management/configuration

Response

If successful, returns a JSON representation of the configured properties (the ones from the configuration.properties file), the runtime properties (the ones from Framework#getProperties), the configuration service properties (the ones contributed to the ConfigurationService), the JVM properties (the ones from System#getProperties) and a selection of miscellaneous properties (like ZoneId#systemDefault). Sensitive information is redacted.

Status Codes

  • 200 _OK_ - Success.

Sample

curl -u Administrator:Administrator \
http://localhost:8080/nuxeo/api/v1/management/configuration
{
  "configuredProperties": {
    "some.nuxeo.property.from.properties.file": "...",
    ...
  },
  "runtimeProperties": {
    "some.nuxeo.runtime.property": "...",
    ...
  },
  "configurationServiceProperties": {
    "some.nuxeo.property from.configuration.service": "...",
    ...
  },
  "jvmProperties": {
    "some.system.property": "...",
    ...
  },
  "miscProperties": {
    "some.miscellaneous.property": "...",
    ...
  }
}