Difference between revisions of "System Properties Web Service"

From FMR Knowledge Base
Jump to navigation Jump to search
(Created page with "Category:FMR_REST_API_Reference = Overview = The Systems Properties web service can be used by an admin user to retrieve detailed information about the FMR instance's oper...")
 
(No difference)

Latest revision as of 03:06, 14 August 2025

Overview

The Systems Properties web service can be used by an admin user to retrieve detailed information about the FMR instance's operating environment

Returns JSON describing:

  • Key directories and file locations - e.g. the Apache Tomcat (Catalina) home directory
  • Java JVM runtime version
  • Operating system
  • Platform architecture - e.g. amd64


Entry Point /ws/secure/settings/getSystemProperties
Access Secure, admin only
Http Method GET
Response Format application/json (array of objects)
Response Statuses

200 - Query Ok

Example

{
[
  {
    "Key": "awt.toolkit",
    "Value": "sun.awt.X11.XToolkit"
  },
  {
    "Key": "catalina.base",
    "Value": "/opt/tomcat"
  },
  {
    "Key": "catalina.home",
    "Value": "/opt/tomcat"
  },
  {
    "Key": "catalina.useNaming",
    "Value": "true"
  },
  {
    "Key": "common.loader",
    "Value": "\"${catalina.base}/lib\",\"${catalina.base}/lib/*.jar\",\"${catalina.home}/lib\",\"${catalina.home}/lib/*.jar\""
  },
  {
    "Key": "file.encoding",
    "Value": "UTF-8"
  },
  {
    "Key": "file.separator",
    "Value": "/"
  },
  {
    "Key": "ignore.endorsed.dirs",
    "Value": ""
  },
  {
    "Key": "java.awt.graphicsenv",
    "Value": "sun.awt.X11GraphicsEnvironment"
  },
  {
    "Key": "java.awt.printerjob",
    "Value": "sun.print.PSPrinterJob"
  },
  {
    "Key": "java.class.path",
    "Value": "/opt/tomcat/bin/bootstrap.jar:/opt/tomcat/bin/tomcat-juli.jar"
  },
  {
    "Key": "java.class.version",
    "Value": "55.0"
  },
  {
    "Key": "java.home",
    "Value": "/opt/java/openjdk"
  },
  {
    "Key": "java.io.tmpdir",
    "Value": "/opt/tomcat/temp"
  },
  {
    "Key": "java.library.path",
    "Value": "/usr/java/packages/lib:/usr/lib64:/lib64:/lib:/usr/lib"
  },
  {
    "Key": "java.naming.factory.initial",
    "Value": "org.apache.naming.java.javaURLContextFactory"
  },
  {
    "Key": "java.naming.factory.url.pkgs",
    "Value": "org.apache.naming"
  },
  {
    "Key": "java.protocol.handler.pkgs",
    "Value": "org.apache.catalina.webresources"
  },
  {
    "Key": "java.runtime.name",
    "Value": "OpenJDK Runtime Environment"
  },
  {
    "Key": "java.runtime.version",
    "Value": "11.0.11+9"
  },
  {
    "Key": "java.specification.name",
    "Value": "Java Platform API Specification"
  },
  {
    "Key": "java.specification.vendor",
    "Value": "Oracle Corporation"
  },
  {
    "Key": "java.specification.version",
    "Value": "11"
  },
  {
    "Key": "java.util.logging.config.file",
    "Value": "/opt/tomcat/conf/logging.properties"
  },
  {
    "Key": "java.util.logging.manager",
    "Value": "org.apache.juli.ClassLoaderLogManager"
  },
  {
    "Key": "java.vendor",
    "Value": "AdoptOpenJDK"
  },
  {
    "Key": "java.vendor.url",
    "Value": "https://adoptopenjdk.net/"
  },
  {
    "Key": "java.vendor.url.bug",
    "Value": "https://github.com/AdoptOpenJDK/openjdk-support/issues"
  },
  {
    "Key": "java.vendor.version",
    "Value": "AdoptOpenJDK-11.0.11+9"
  },
  {
    "Key": "java.version",
    "Value": "11.0.11"
  },
  {
    "Key": "java.version.date",
    "Value": "2021-04-20"
  },
  {
    "Key": "java.vm.compressedOopsMode",
    "Value": "Zero based"
  },
  {
    "Key": "java.vm.info",
    "Value": "mixed mode"
  },
  {
    "Key": "java.vm.name",
    "Value": "OpenJDK 64-Bit Server VM"
  },
  {
    "Key": "java.vm.specification.name",
    "Value": "Java Virtual Machine Specification"
  },
  {
    "Key": "java.vm.specification.vendor",
    "Value": "Oracle Corporation"
  },
  {
    "Key": "java.vm.specification.version",
    "Value": "11"
  },
  {
    "Key": "java.vm.vendor",
    "Value": "AdoptOpenJDK"
  },
  {
    "Key": "java.vm.version",
    "Value": "11.0.11+9"
  },
  {
    "Key": "jdk.debug",
    "Value": "release"
  },
  {
    "Key": "jdk.tls.ephemeralDHKeySize",
    "Value": "2048"
  },
  {
    "Key": "line.separator",
    "Value": "\n"
  },
  {
    "Key": "oracle.jdbc.J2EE13Compliant",
    "Value": "true"
  },
  {
    "Key": "org.apache.catalina.security.SecurityListener.UMASK",
    "Value": "0027"
  },
  {
    "Key": "os.arch",
    "Value": "amd64"
  },
  {
    "Key": "os.name",
    "Value": "Linux"
  },
  {
    "Key": "os.version",
    "Value": "6.6.87.2-microsoft-standard-WSL2"
  },
  {
    "Key": "package.access",
    "Value": "sun.,org.apache.catalina.,org.apache.coyote.,org.apache.jasper.,org.apache.tomcat."
  },
  {
    "Key": "package.definition",
    "Value": "sun.,java.,org.apache.catalina.,org.apache.coyote.,org.apache.jasper.,org.apache.naming.,org.apache.tomcat."
  },
  {
    "Key": "path.separator",
    "Value": ":"
  },
  {
    "Key": "server.loader",
    "Value": ""
  },
  {
    "Key": "shared.loader",
    "Value": ""
  },
  {
    "Key": "sun.arch.data.model",
    "Value": "64"
  },
  {
    "Key": "sun.boot.library.path",
    "Value": "/opt/java/openjdk/lib"
  },
  {
    "Key": "sun.cpu.endian",
    "Value": "little"
  },
  {
    "Key": "sun.cpu.isalist",
    "Value": ""
  },
  {
    "Key": "sun.io.unicode.encoding",
    "Value": "UnicodeLittle"
  },
  {
    "Key": "sun.java.command",
    "Value": "org.apache.catalina.startup.Bootstrap start"
  },
  {
    "Key": "sun.java.launcher",
    "Value": "SUN_STANDARD"
  },
  {
    "Key": "sun.jnu.encoding",
    "Value": "UTF-8"
  },
  {
    "Key": "sun.management.compiler",
    "Value": "HotSpot 64-Bit Tiered Compilers"
  },
  {
    "Key": "sun.os.patch.level",
    "Value": "unknown"
  },
  {
    "Key": "tomcat.util.buf.StringCache.byte.enabled",
    "Value": "true"
  },
  {
    "Key": "tomcat.util.scan.StandardJarScanFilter.jarsToScan",
    "Value": "log4j-taglib*.jar,log4j-web*.jar,log4javascript*.jar,slf4j-taglib*.jar"
  },
  {
    "Key": "tomcat.util.scan.StandardJarScanFilter.jarsToSkip",
    "Value": "annotations-api.jar,ant-junit*.jar,ant-launcher.jar,ant.jar,asm-*.jar,aspectj*.jar,bootstrap.jar,catalina-ant.jar,catalina-ha.jar,catalina-ssi.jar,catalina-storeconfig.jar,catalina-tribes.jar,catalina.jar,cglib-*.jar,cobertura-*.jar,commons-beanutils*.jar,commons-codec*.jar,commons-collections*.jar,commons-daemon.jar,commons-dbcp*.jar,commons-digester*.jar,commons-fileupload*.jar,commons-httpclient*.jar,commons-io*.jar,commons-lang*.jar,commons-logging*.jar,commons-math*.jar,commons-pool*.jar,dom4j-*.jar,easymock-*.jar,ecj-*.jar,el-api.jar,geronimo-spec-jaxrpc*.jar,h2*.jar,hamcrest-*.jar,hibernate*.jar,httpclient*.jar,icu4j-*.jar,jasper-el.jar,jasper.jar,jaspic-api.jar,jaxb-*.jar,jaxen-*.jar,jdom-*.jar,jetty-*.jar,jmx-tools.jar,jmx.jar,jsp-api.jar,jstl.jar,jta*.jar,junit-*.jar,junit.jar,log4j*.jar,mail*.jar,objenesis-*.jar,oraclepki.jar,oro-*.jar,servlet-api-*.jar,servlet-api.jar,slf4j*.jar,taglibs-standard-spec-*.jar,tagsoup-*.jar,tomcat-api.jar,tomcat-coyote.jar,tomcat-dbcp.jar,tomcat-i18n-*.jar,tomcat-jdbc.jar,tomcat-jni.jar,tomcat-juli-adapters.jar,tomcat-juli.jar,tomcat-util-scan.jar,tomcat-util.jar,tomcat-websocket.jar,tools.jar,websocket-api.jar,wsdl4j*.jar,xercesImpl.jar,xml-apis.jar,xmlParserAPIs-*.jar,xmlParserAPIs.jar,xom-*.jar"
  },
  {
    "Key": "user.country",
    "Value": "US"
  },
  {
    "Key": "user.dir",
    "Value": "/tmp"
  },
  {
    "Key": "user.home",
    "Value": "/opt/tomcat"
  },
  {
    "Key": "user.language",
    "Value": "en"
  },
  {
    "Key": "user.name",
    "Value": "tomcat"
  },
  {
    "Key": "user.timezone",
    "Value": "GMT"
  }
]
}