System Info Handler
This API provides the same information displayed on the Dashboard.
Request
"System"-level information for individual nodes can be fetched with the API below:
-
V1 API
-
V2 API
http://localhost:8983/solr/admin/system
http://localhost:8983/api/node/system
Response
The keys in the result are:
mode-
Either
solrcloudorstd, indicating the mode Solr is running in standalone mode. solr_home-
Solr base directory.
core_root-
Solr core base directory.
zkHost-
Zookeeper host, when running in cloud mode.
node-
Node name, when running cloud mode.
lucene-
An object containing Solr and Lucene version information
jvm-
An object containing information on the JVM
system-
Information on the system.
security-
Information on security.
gpu-
Information on GPUs.
Lucene and Solr Versions Information Object
The lucene key in the response is an object with these keys:
lucene-spec-version-
The specification version of the Lucene package.
lucene-impl-version-
The implementation version of the Lucene package.
solr-spec-version-
The specification version of the Solr package.
solr-impl-version-
The implementation version of the Solr package.
JVM Information Object
The jvm key in the response is an object with these keys and more:
version-
JVM specification version.
name-
Name of the JVM.
memory-
An object containing memory usage information.
System Information Object
The system key in the response is a map of the underlying system information, containing these keys, and more:
name-
Operating system name.
uname-
The result of running
uname -a. Not available on Windows. uptime-
The result of running
uptime. Not available on Windows.
Security Information Object
The security key in the response is an object with these keys:
tls-
Flag to indicate if TLS is enabled or not. If disabled, this is the only key in the response.
authenticationPlugin-
The name of the configured authentication plugin.
authorizationPlugin-
The name of the configured authorization plugin.
username-
The name of the current user.
roles-
The roles of the current user.
permissions-
The permissions of the current user.
GPU Information Object
The gpu key in the response is an object with these keys:
available-
Flag to indicate if GPU is available or not. If unavailable, this is the only key in the response.
count-
Count of available GPUs.
memory-
An object listing the 'free', 'total', and 'used' memory.
devices-
A listing of the GPU devices.
Examples
Examples on this page refer to the V2 API.
Retrieve system information from a node in cloud mode.
curl http://localhost:8983/api/node/system
{
"responseHeader": {
"status": 0,
"QTime": 4
},
"node": "localhost:8983_solr",
"mode": "solrcloud",
"zkHost": "127.0.0.1:9983",
"solr_home": "/opt/solr/example/cloud/node1/solr",
"core_root": "/opt/solr/example/cloud/node1/solr",
"lucene": {
"solr-spec-version": "11.0.0",
"solr-impl-version": "11.0.0-SNAPSHOT f096b9a8aa2e10b8d2e87d7b8699953544d0f4f6 [snapshot build, details omitted]",
"lucene-spec-version": "10.3.2",
"lucene-impl-version": "10.3.2 dadfd90b4401947f4d0387669dc94999fbb2c830 - 2025-11-13 10:41:29"
},
"jvm": {
"name": "Ubuntu OpenJDK 64-Bit Server VM",
"version": "21.0.9 21.0.9+10-Ubuntu-124.04",
"processors": 4,
"jre": {
"vendor": "Ubuntu",
"version": "21.0.9"
},
"spec": {
"name": "Java Platform API Specification",
"vendor": "Oracle Corporation",
"version": "21"
},
"vm": {
"name": "OpenJDK 64-Bit Server VM",
"vendor": "Ubuntu",
"version": "21.0.9+10-Ubuntu-124.04"
},
"jmx": {
"classpath": "start.jar",
"startTime": 1771355675708,
"upTimeMS": 1695023,
"commandLineArgs": [
"-Xms512m",
"-Xmx512m",
"-XX:+UseG1GC",
"-XX:+PerfDisableSharedMem",
"-XX:+ParallelRefProcEnabled",
"-XX:MaxGCPauseMillis=250",
"-XX:+UseLargePages",
"-XX:+AlwaysPreTouch",
"-XX:+ExplicitGCInvokesConcurrent",
"-Xlog:gc*:file=/opt/solr/../logs/solr_gc.log:time,uptime:filecount=9,filesize=20M",
"-Dsolr.jetty.inetaccess.includes=",
"-Dsolr.jetty.inetaccess.excludes=",
"-Dsolr.zookeeper.client.timeout=30000",
"-Dsolr.zookeeper.server.enabled=true",
"-Dsolr.logs.dir=/opt/solr/../logs",
"-Dsolr.port.listen=8983",
"-DSTOP.PORT=7983",
"-DSTOP.KEY=solrrocks",
"-Djava.io.tmpdir=/tmp",
"-Dsolr.host.advertise=localhost",
"-Duser.timezone=UTC",
"-XX:-OmitStackTraceInFastThrow",
"-XX:+CrashOnOutOfMemoryError",
"-XX:ErrorFile=/opt/solr/../logs/jvm_crash_%p.log",
"-Djetty.home=/opt/solr/server",
"-Dsolr.solr.home=/opt/solr/example/cloud/node1/solr",
"-Dsolr.install.dir=/opt/solr/",
"-Dsolr.install.symDir=/opt/solr/",
"-Dlog4j.configurationFile=/opt/solr/server/resources/log4j2.xml",
"-Xss256k",
"--add-modules=jdk.incubator.vector",
"--enable-native-access=ALL-UNNAMED",
"-Djava.security.manager",
"-Djava.security.policy=/opt/solr/server/etc/security.policy",
"-Djava.security.properties=/opt/solr/server/etc/security.properties",
"-Dsolr.internal.network.permission=*",
"-Dsolr.log.muteconsole"
]
"memory": {
"free": "229.5 MB",
"total": "512 MB",
"max": "512 MB",
"used": "282.5 MB (%55.2)",
"raw": {
"free": 240673856,
"total": 536870912,
"used": 296197056,
"max": 536870912,
"used%": 55.171000957489014
}
}
},
"security": {
"tls": false
},
"gpu": {
"available": false,
"count": 0
},
"system": {
"freePhysicalMemorySize": "2985586688",
"totalMemorySize": "8307912704",
"availableProcessors": "4",
"freeMemorySize": "2985586688",
"openFileDescriptorCount": "196",
"freeSwapSpaceSize": "2660519936",
"maxFileDescriptorCount": "65536",
"version": "6.14.0-33-generic",
"totalSwapSpaceSize": "4294963200",
"committedVirtualMemorySize": "4357632000",
"cpuLoad": "0.06624527740181138",
"systemLoadAverage": "0.3193359375",
"processCpuLoad": "0.004622084725943523",
"systemCpuLoad": "0.0",
"processCpuTime": "43450000000",
"name": "Linux",
"totalPhysicalMemorySize": "8307912704",
"arch": "amd64"
}
}
}