Implicit RequestHandlers

Solr ships with many out-of-the-box RequestHandlers, which are called implicit because they are not configured in solrconfig.xml.

These handlers have pre-defined default parameters, known as paramsets, which can be modified if necessary.

List of Implicitly Available Endpoints

Endpoint Request Handler class Paramset Description

/admin/file

{solr-javadocs}/solr-core/org/apache/solr/handler/admin/ShowFileRequestHandler.html[ShowFileRequestHandler]

_ADMIN_FILE

Returns content of files in ${solr.home} /conf/.

/admin/logging

{solr-javadocs}/solr-core/org/apache/solr/handler/admin/ShowFileRequestHandler.html[LoggingHandler]

_ADMIN_LOGGING

Retrieve/modify registered loggers.

/admin/luke

{solr-javadocs}/solr-core/org/apache/solr/handler/admin/LukeRequestHandler.html[LukeRequestHandler]

_ADMIN_LUKE

Expose the internal lucene index.

/admin/mbeans

{solr-javadocs}/solr-core/org/apache/solr/handler/admin/SolrInfoMBeanHandler.html[SolrInfoMBeanHandler]

_ADMIN_MBEANS

Provide info about all registered {solr-javadocs}/solr-core/org/apache/solr/core/SolrInfoMBean.html[SolrInfoMBeans].

/admin/ping

{solr-javadocs}/solr-core/org/apache/solr/handler/PingRequestHandler.html[PingRequestHandler]

_ADMIN_PING

Health check.

/admin/plugins

{solr-javadocs}/solr-core/org/apache/solr/handler/admin/PluginInfoHandler.html[PluginInfoHandler]

N/A

Return info about all registered plugins.

/admin/properties

{solr-javadocs}/solr-core/org/apache/solr/handler/admin/PropertiesRequestHandler.html[PropertiesRequestHandler]

_ADMIN_PROPERTIES

Return JRE system properties.

/admin/segments

{solr-javadocs}/solr-core/org/apache/solr/handler/admin/SegmentsInfoRequestHandler.html[SegmentsInfoRequestHandler]

_ADMIN_SEGMENTS

Return info on last commit generation Lucene index segments.

/admin/system

{solr-javadocs}/solr-core/org/apache/solr/handler/admin/SystemInfoHandler.html[SystemInfoHandler]

_ADMIN_SYSTEM

Return server statistics and settings

/admin/threads

{solr-javadocs}/solr-core/org/apache/solr/handler/admin/ThreadDumpHandler.html[ThreadDumpHandler]

_ADMIN_THREADS

Return info on all JVM threads.

/analysis/document

{solr-javadocs}/solr-core/org/apache/solr/handler/DocumentAnalysisRequestHandler.html[DocumentAnalysisRequestHandler]

_ANALYSIS_DOCUMENT

Return a breakdown of the analysis process of the given document.

/analysis/field

{solr-javadocs}/solr-core/org/apache/solr/handler/FieldAnalysisRequestHandler.html[FieldAnalysisRequestHandler]

_ANALYSIS_FIELD

Return index- and query-time analysis over the given field(s)/field type(s).

/config

{solr-javadocs}/solr-core/org/apache/solr/handler/SolrConfigHandler.html[SolrConfigHandler]

_CONFIG

Retrieve/modify Solr configuration.

/debug/dump

{solr-javadocs}/solr-core/org/apache/solr/handler/DumpRequestHandler.html[DumpRequestHandler]

_DEBUG_DUMP

Echo the request contents back to the client.

/export

{solr-javadocs}/solr-core/org/apache/solr/handler/component/ExportHandler.html[ExportHandler]

_EXPORT

Export full sorted result sets.

/get

{solr-javadocs}/solr-core/org/apache/solr/handler/RealTimeGetHandler.html[RealTimeGetHandler]

_GET

Real-time get: low-latency retrieval of the latest version of a document.

/graph

{solr-javadocs}/solr-core/org/apache/solr/handler/GraphHandler.html[GraphHandler]

_ADMIN_GRAPH

Return GraphML formatted output from a gather Nodes streaming expression.

/replication

{solr-javadocs}/solr-core/org/apache/solr/handler/ReplicationHandler.html[ReplicationHandler]

_REPLICATION

Replicate indexes for SolrCloud recovery and Master/Slave index distribution.

/schema

{solr-javadocs}/solr-core/org/apache/solr/handler/SchemaHandler.html[SchemaHandler]

_SCHEMA

Retrieve/modify Solr schema.

/sql

{solr-javadocs}/solr-core/org/apache/solr/handler/SQLHandler.html[SQLHandler]

_SQL

Front end of the Parallel SQL interface.

/stream

{solr-javadocs}/solr-core/org/apache/solr/handler/StreamHandler.html[StreamHandler]

_STREAM

Distributed stream processing.

/terms

{solr-javadocs}/solr-core/org/apache/solr/handler/component/SearchHandler.html[SearchHandler]

_TERMS

Return a field’s indexed terms and the number of documents containing each term.

/update

{solr-javadocs}/solr-core/org/apache/solr/handler/UpdateRequestHandler.html[UpdateRequestHandler]

_UPDATE

Add, delete and update indexed documents formatted as SolrXML, CSV, SolrJSON or javabin.

/update/csv

{solr-javadocs}/solr-core/org/apache/solr/handler/UpdateRequestHandler.html[UpdateRequestHandler]

_UPDATE_CSV

Add and update CSV-formatted documents.

/update/json

{solr-javadocs}/solr-core/org/apache/solr/handler/UpdateRequestHandler.html[UpdateRequestHandler]

_UPDATE_JSON

Add, delete and update SolrJSON-formatted documents.

/update/json/docs

{solr-javadocs}/solr-core/org/apache/solr/handler/UpdateRequestHandler.html[UpdateRequestHandler]

_UPDATE_JSON_DOCS

Add and update custom JSON-formatted documents.

How to View the Configuration

You can see configuration for all request handlers, including the implicit request handlers, via the Config API. For the gettingstarted collection:

curl http://localhost:8983/solr/gettingstarted/config/requestHandler

To restrict the results to the configuration for a particular request handler, use the componentName request parameter. To see just the configuration for the /export request handler:

curl "http://localhost:8983/solr/gettingstarted/config/requestHandler?componentName=/export"

To include the expanded paramset in the response, as well as the effective parameters from merging the paramset parameters with the built-in parameters, use the expandParams request param. For the /export request handler, you can make a request like this:

curl "http://localhost:8983/solr/gettingstarted/config/requestHandler?componentName=/export&expandParams=true"

How to Edit the Configuration

Because implicit request handlers are not present in solrconfig.xml, configuration of their associated default, invariant and appends parameters may be edited via Request Parameters API using the paramset listed in the above table. However, other parameters, including SearchHandler components, may not be modified. The invariants and appends specified in the implicit configuration cannot be overridden.