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

ShowFileRequestHandler

_ADMIN_FILE

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

/admin/logging

LoggingHandler

_ADMIN_LOGGING

Retrieve/modify registered loggers.

/admin/luke

LukeRequestHandler

_ADMIN_LUKE

Expose the internal lucene index.

/admin/mbeans

SolrInfoMBeanHandler

_ADMIN_MBEANS

Provide info about all registered SolrInfoMBeans.

/admin/ping

PingRequestHandler

_ADMIN_PING

Health check.

/admin/plugins

PluginInfoHandler

N/A

Return info about all registered plugins.

/admin/properties

PropertiesRequestHandler

_ADMIN_PROPERTIES

Return JRE system properties.

/admin/segments

SegmentsInfoRequestHandler

_ADMIN_SEGMENTS

Return info on last commit generation Lucene index segments.

/admin/system

SystemInfoHandler

_ADMIN_SYSTEM

Return server statistics and settings

/admin/threads

ThreadDumpHandler

_ADMIN_THREADS

Return info on all JVM threads.

/analysis/document

DocumentAnalysisRequestHandler

_ANALYSIS_DOCUMENT

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

/analysis/field

FieldAnalysisRequestHandler

_ANALYSIS_FIELD

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

/config

SolrConfigHandler

_CONFIG

Retrieve/modify Solr configuration.

/debug/dump

DumpRequestHandler

_DEBUG_DUMP

Echo the request contents back to the client.

/export

ExportHandler

_EXPORT

Export full sorted result sets.

/get

RealTimeGetHandler

_GET

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

/graph

GraphHandler

_ADMIN_GRAPH

Return GraphML formatted output from a gather Nodes streaming expression.

/replication

ReplicationHandler

_REPLICATION

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

/schema

SchemaHandler

_SCHEMA

Retrieve/modify Solr schema.

/sql

SQLHandler

_SQL

Front end of the Parallel SQL interface.

/stream

StreamHandler

_STREAM

Distributed stream processing.

/terms

SearchHandler

_TERMS

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

/update

UpdateRequestHandler

_UPDATE

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

/update/csv

UpdateRequestHandler

_UPDATE_CSV

Add and update CSV-formatted documents.

/update/json

UpdateRequestHandler

_UPDATE_JSON

Add, delete and update SolrJSON-formatted documents.

/update/json/docs

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.

Comments on this Page

We welcome feedback on Solr documentation. However, we cannot provide application support via comments. If you need help, please send a message to the Solr User mailing list.