elasticsearch-api.info

Filter

Action	Methods	Paths	Parts	Description	Params	Documentation
bulk	POST, PUT	/_bulk/{index}/_bulk/{index}/{type}/_bulk	index: Default index for items which don't provide one type: Default document type for items which don't provide one	The operation definition and data (action-data pairs), separated by newlines	consistency (enum): Explicit write consistency setting for the operation [ one, quorum, all ] fields (list): Default comma-separated list of fields to return in the response for updates pipeline (string): The pipeline id to preprocess incoming documents with refresh (boolean): Refresh the index after performing the operation routing (string): Specific routing value timeout (time): Explicit operation timeout type (string): Default document type for items which don't provide one	[link]
cat.aliases	GET	/_cat/aliases/_cat/aliases/{name}	name: A comma-separated list of alias names to return		format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node v (boolean): Verbose mode. Display column headers	[link]
cat.allocation	GET	/_cat/allocation/_cat/allocation/{node_id}	node_id: A comma-separated list of node IDs or names to limit the returned information		bytes (enum): The unit in which to display byte values [ b, k, m, g ] format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node v (boolean): Verbose mode. Display column headers	[link]
cat.count	GET	/_cat/count/_cat/count/{index}	index: A comma-separated list of index names to limit the returned information		format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node v (boolean): Verbose mode. Display column headers	[link]
cat.fielddata	GET	/_cat/fielddata/_cat/fielddata/{fields}	fields: A comma-separated list of fields to return the fielddata size		bytes (enum): The unit in which to display byte values [ b, k, m, g ] fields (list): A comma-separated list of fields to return in the output format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node v (boolean): Verbose mode. Display column headers	[link]
cat.health	GET	/_cat/health			format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node ts (boolean): Set to false to disable timestamping ( default: true ) v (boolean): Verbose mode. Display column headers	[link]
cat.help	GET	/_cat			help (boolean): Return help information	[link]
cat.indices	GET	/_cat/indices/_cat/indices/{index}	index: A comma-separated list of index names to limit the returned information		bytes (enum): The unit in which to display byte values [ b, k, m, g ] format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node pri (boolean): Set to true to return stats only for primary shards v (boolean): Verbose mode. Display column headers	[link]
cat.master	GET	/_cat/master			format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node v (boolean): Verbose mode. Display column headers	[link]
cat.nodeattrs	GET	/_cat/nodeattrs			format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node v (boolean): Verbose mode. Display column headers	[link]
cat.nodes	GET	/_cat/nodes			format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node v (boolean): Verbose mode. Display column headers	[link]
cat.pending_tasks	GET	/_cat/pending_tasks			format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node v (boolean): Verbose mode. Display column headers	[link]
cat.plugins	GET	/_cat/plugins			format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node v (boolean): Verbose mode. Display column headers	[link]
cat.recovery	GET	/_cat/recovery/_cat/recovery/{index}	index: A comma-separated list of index names to limit the returned information		bytes (enum): The unit in which to display byte values [ b, k, m, g ] format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information master_timeout (time): Explicit operation timeout for connection to master node v (boolean): Verbose mode. Display column headers	[link]
cat.repositories	GET	/_cat/repositories			format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information local (boolean): Return local information, do not retrieve the state from master node master_timeout (time): Explicit operation timeout for connection to master node v (boolean): Verbose mode. Display column headers	[link]
cat.segments	GET	/_cat/segments/_cat/segments/{index}	index: A comma-separated list of index names to limit the returned information		format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information v (boolean): Verbose mode. Display column headers	[link]
cat.shards	GET	/_cat/shards/_cat/shards/{index}	index: A comma-separated list of index names to limit the returned information		format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node v (boolean): Verbose mode. Display column headers	[link]
cat.snapshots	GET	/_cat/snapshots/{repository}	repository: Name of repository from which to fetch the snapshot information		format (string): a short version of the Accept header, e.g. json, yaml h (list): Comma-separated list of column names to display help (boolean): Return help information ignore_unavailable (boolean): Set to true to ignore unavailable snapshots master_timeout (time): Explicit operation timeout for connection to master node v (boolean): Verbose mode. Display column headers	[link]
cat.thread_pool	GET	/_cat/thread_pool			format (string): a short version of the Accept header, e.g. json, yaml full_id (boolean): Enables displaying the complete node ids h (list): Comma-separated list of column names to display help (boolean): Return help information local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node v (boolean): Verbose mode. Display column headers	[link]
clear_scroll	DELETE	/_search/scroll/{scroll_id}/_search/scroll	scroll_id: A comma-separated list of scroll IDs to clear	A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter		[link]
cluster.get_settings	GET	/_cluster/settings			flat_settings (boolean): Return settings in flat format (default: false) include_defaults (boolean): Whether to return all default clusters setting. master_timeout (time): Explicit operation timeout for connection to master node timeout (time): Explicit operation timeout	[link]
cluster.health	GET	/_cluster/health/_cluster/health/{index}	index: Limit the information returned to a specific index		level (enum): Specify the level of detail for returned information [ cluster, indices, shards ]( default: true ) local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node timeout (time): Explicit operation timeout wait_for_active_shards (number): Wait until the specified number of shards is active wait_for_nodes (string): Wait until the specified number of nodes is available wait_for_relocating_shards (number): Wait until the specified number of relocating shards is finished wait_for_status (enum): Wait until cluster is in a specific state [ green, yellow, red ]	[link]
cluster.pending_tasks	GET	/_cluster/pending_tasks			local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Specify timeout for connection to master	[link]
cluster.put_settings	PUT	/_cluster/settings		The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart).	flat_settings (boolean): Return settings in flat format (default: false) master_timeout (time): Explicit operation timeout for connection to master node timeout (time): Explicit operation timeout	[link]
cluster.reroute	POST	/_cluster/reroute		The definition of `commands` to perform (`move`, `cancel`, `allocate`)	dry_run (boolean): Simulate the operation only and return the resulting state explain (boolean): Return an explanation of why the commands can or cannot be executed master_timeout (time): Explicit operation timeout for connection to master node metric (list): Limit the information returned to the specified metrics. Defaults to all but metadata [ _all, blocks, metadata, nodes, routing_table, master_node, version ] timeout (time): Explicit operation timeout	[link]
cluster.state	GET	/_cluster/state/_cluster/state/{metric}/_cluster/state/{metric}/{index}	index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices metric: Limit the information returned to the specified metrics		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) flat_settings (boolean): Return settings in flat format (default: false) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Specify timeout for connection to master	[link]
cluster.stats	GET	/_cluster/stats/_cluster/stats/nodes/{node_id}	node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes		flat_settings (boolean): Return settings in flat format (default: false) human (boolean): Whether to return time and byte values in human-readable format. timeout (time): Explicit operation timeout	[link]
count	POST, GET	/_count/{index}/_count/{index}/{type}/_count	index: A comma-separated list of indices to restrict the results type: A comma-separated list of types to restrict the results	A query to restrict the results specified with the Query DSL (optional)	allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) analyze_wildcard (boolean): Specify whether wildcard and prefix queries should be analyzed (default: false) analyzer (string): The analyzer to use for the query string default_operator (enum): The default operator for query string query (AND or OR) [ AND, OR ]( default: true ) df (string): The field to use as default where no field prefix is given in the query string expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) lenient (boolean): Specify whether format-based query failures (such as providing text to a numeric field) should be ignored lowercase_expanded_terms (boolean): Specify whether query terms should be lowercased min_score (number): Include only documents with a specific `_score` value in the result preference (string): Specify the node or shard the operation should be performed on (default: random) q (string): Query in the Lucene query string syntax routing (string): Specific routing value	[link]
count_percolate	GET, POST	/{index}/{type}/_percolate/count/{index}/{type}/{id}/_percolate/count	id: Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. index: The index of the document being count percolated. type: The type of the document being count percolated.	The count percolator request definition using the percolate DSL	allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) percolate_index (string): The index to count percolate the document into. Defaults to index. percolate_type (string): The type to count percolate document into. Defaults to type. preference (string): Specify the node or shard the operation should be performed on (default: random) routing (list): A comma-separated list of specific routing values version (number): Explicit version number for concurrency control version_type (enum): Specific version type [ internal, external, external_gte, force ]	[link]
delete	DELETE	/{index}/{type}/{id}	id: The document ID index: The name of the index type: The type of the document		consistency (enum): Specific write consistency setting for the operation [ one, quorum, all ] parent (string): ID of parent document refresh (boolean): Refresh the index after performing the operation routing (string): Specific routing value timeout (time): Explicit operation timeout version (number): Explicit version number for concurrency control version_type (enum): Specific version type [ internal, external, external_gte, force ]	[link]
delete_script	DELETE	/_scripts/{lang}/{id}	id: Script ID lang: Script language		version (number): Explicit version number for concurrency control version_type (enum): Specific version type [ internal, external, external_gte, force ]	[link]
delete_template	DELETE	/_search/template/{id}	id: Template ID		version (number): Explicit version number for concurrency control version_type (enum): Specific version type [ internal, external, external_gte, force ]	[link]
exists	HEAD	/{index}/{type}/{id}	id: The document ID index: The name of the index type: The type of the document (use `_all` to fetch the first document matching the ID across all types)		parent (string): The ID of the parent document preference (string): Specify the node or shard the operation should be performed on (default: random) realtime (boolean): Specify whether to perform the operation in realtime or search mode refresh (boolean): Refresh the shard containing the document before performing the operation routing (string): Specific routing value	[link]
explain	GET, POST	/{index}/{type}/{id}/_explain	id: The document ID index: The name of the index type: The type of the document	The query definition using the Query DSL	_source (list): True or false to return the _source field or not, or a list of fields to return _source_exclude (list): A list of fields to exclude from the returned _source field _source_include (list): A list of fields to extract and return from the _source field analyze_wildcard (boolean): Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false) analyzer (string): The analyzer for the query string query default_operator (enum): The default operator for query string query (AND or OR) [ AND, OR ]( default: true ) df (string): The default field for query string query (default: _all) fields (list): A comma-separated list of fields to return in the response lenient (boolean): Specify whether format-based query failures (such as providing text to a numeric field) should be ignored lowercase_expanded_terms (boolean): Specify whether query terms should be lowercased parent (string): The ID of the parent document preference (string): Specify the node or shard the operation should be performed on (default: random) q (string): Query in the Lucene query string syntax routing (string): Specific routing value	[link]
field_stats	GET, POST	/_field_stats/{index}/_field_stats	index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices	Field json objects containing the name and optionally a range to filter out indices result, that have results outside the defined bounds	allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) fields (list): A comma-separated list of fields for to get field statistics for (min value, max value, and more) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) level (enum): Defines if field stats should be returned on a per index level or on a cluster wide level [ indices, cluster ]( default: true )	[link]
get	GET	/{index}/{type}/{id}	id: The document ID index: The name of the index type: The type of the document (use `_all` to fetch the first document matching the ID across all types)		_source (list): True or false to return the _source field or not, or a list of fields to return _source_exclude (list): A list of fields to exclude from the returned _source field _source_include (list): A list of fields to extract and return from the _source field fields (list): A comma-separated list of fields to return in the response parent (string): The ID of the parent document preference (string): Specify the node or shard the operation should be performed on (default: random) realtime (boolean): Specify whether to perform the operation in realtime or search mode refresh (boolean): Refresh the shard containing the document before performing the operation routing (string): Specific routing value version (number): Explicit version number for concurrency control version_type (enum): Specific version type [ internal, external, external_gte, force ]	[link]
get_script	GET	/_scripts/{lang}/{id}	id: Script ID lang: Script language		version (number): Explicit version number for concurrency control version_type (enum): Specific version type [ internal, external, external_gte, force ]	[link]
get_source	GET	/{index}/{type}/{id}/_source	id: The document ID index: The name of the index type: The type of the document; use `_all` to fetch the first document matching the ID across all types		_source (list): True or false to return the _source field or not, or a list of fields to return _source_exclude (list): A list of fields to exclude from the returned _source field _source_include (list): A list of fields to extract and return from the _source field parent (string): The ID of the parent document preference (string): Specify the node or shard the operation should be performed on (default: random) realtime (boolean): Specify whether to perform the operation in realtime or search mode refresh (boolean): Refresh the shard containing the document before performing the operation routing (string): Specific routing value version (number): Explicit version number for concurrency control version_type (enum): Specific version type [ internal, external, external_gte, force ]	[link]
get_template	GET	/_search/template/{id}	id: Template ID		version (number): Explicit version number for concurrency control version_type (enum): Specific version type [ internal, external, external_gte, force ]	[link]
index	POST, PUT	/{index}/{type}/{index}/{type}/{id}	id: Document ID index: The name of the index type: The type of the document	The document	consistency (enum): Explicit write consistency setting for the operation [ one, quorum, all ] op_type (enum): Explicit operation type [ index, create ]( default: true ) parent (string): ID of the parent document pipeline (string): The pipeline id to preprocess incoming documents with refresh (boolean): Refresh the index after performing the operation routing (string): Specific routing value timeout (time): Explicit operation timeout timestamp (time): Explicit timestamp for the document ttl (duration): Expiration time for the document version (number): Explicit version number for concurrency control version_type (enum): Specific version type [ internal, external, external_gte, force ]	[link]
indices.analyze	GET, POST	/_analyze/{index}/_analyze	index: The name of the index to scope the operation	The text on which the analysis should be performed	analyzer (string): The name of the analyzer to use attributes (list): A comma-separated list of token attributes to output, this parameter works only with `explain=true` char_filters (list): A comma-separated list of character filters to use for the analysis explain (boolean): With `true`, outputs more advanced details. (default: false) field (string): Use the analyzer configured for this field (instead of passing the analyzer name) filters (list): A comma-separated list of filters to use for the analysis format (enum): Format of the output [ detailed, text ]( default: true ) index (string): The name of the index to scope the operation prefer_local (boolean): With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true) text (list): The text on which the analysis should be performed (when request body is not used) tokenizer (string): The name of the tokenizer to use for the analysis	[link]
indices.clear_cache	POST, GET	/_cache/clear/{index}/_cache/clear	index: A comma-separated list of index name to limit the operation		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) field_data (boolean): Clear field data fielddata (boolean): Clear field data fields (list): A comma-separated list of fields to clear when using the `field_data` parameter (default: all) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) index (list): A comma-separated list of index name to limit the operation query (boolean): Clear query caches recycler (boolean): Clear the recycler cache request (boolean): Clear request cache	[link]
indices.close	POST	/{index}/_close	index: A comma separated list of indices to close		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) master_timeout (time): Specify timeout for connection to master timeout (time): Explicit operation timeout	[link]
indices.create	PUT, POST	/{index}	index: The name of the index	The configuration for the index (`settings` and `mappings`)	master_timeout (time): Specify timeout for connection to master timeout (time): Explicit operation timeout update_all_types (boolean): Whether to update the mapping for all fields with the same name across all types or not	[link]
indices.delete	DELETE	/{index}	index: A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices		master_timeout (time): Specify timeout for connection to master timeout (time): Explicit operation timeout	[link]
indices.delete_alias	DELETE	/{index}/_alias/{name}/{index}/_aliases/{name}	index: A comma-separated list of index names (supports wildcards); use `_all` for all indices name: A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.		master_timeout (time): Specify timeout for connection to master timeout (time): Explicit timestamp for the document	[link]
indices.delete_template	DELETE	/_template/{name}	name: The name of the template		master_timeout (time): Specify timeout for connection to master timeout (time): Explicit operation timeout	[link]
indices.exists	HEAD	/{index}	index: A comma-separated list of indices to check		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) local (boolean): Return local information, do not retrieve the state from master node (default: false)	[link]
indices.exists_alias	HEAD	/_alias/{name}/{index}/_alias/{name}/{index}/_alias	index: A comma-separated list of index names to filter aliases name: A comma-separated list of alias names to return		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) local (boolean): Return local information, do not retrieve the state from master node (default: false)	[link]
indices.exists_template	HEAD	/_template/{name}	name: The name of the template		local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node	[link]
indices.exists_type	HEAD	/{index}/{type}	index: A comma-separated list of index names; use `_all` to check the types across all indices type: A comma-separated list of document types to check		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) local (boolean): Return local information, do not retrieve the state from master node (default: false)	[link]
indices.flush	POST, GET	/_flush/{index}/_flush	index: A comma-separated list of index names; use `_all` or empty string for all indices		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) force (boolean): Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) wait_if_ongoing (boolean): If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is false and will cause an exception to be thrown on the shard level if another flush operation is already running.	[link]
indices.flush_synced	POST, GET	/_flush/synced/{index}/_flush/synced	index: A comma-separated list of index names; use `_all` or empty string for all indices		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed)	[link]
indices.forcemerge	POST	/_forcemerge/{index}/_forcemerge	index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) flush (boolean): Specify whether the index should be flushed after performing the operation (default: true) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) max_num_segments (number): The number of segments the index should be merged into (default: dynamic) only_expunge_deletes (boolean): Specify whether the operation should only expunge deleted documents operation_threading (): TODO: ? wait_for_merge (boolean): Specify whether the request should block until the merge process is finished (default: true)	[link]
indices.get	GET	/{index}/{index}/{feature}	feature: A comma-separated list of features index: A comma-separated list of index names		allow_no_indices (boolean): Ignore if a wildcard expression resolves to no concrete indices (default: false) expand_wildcards (enum): Whether wildcard expressions should get expanded to open or closed indices (default: open) [ open, closed, none, all ]( default: true ) flat_settings (boolean): Return settings in flat format (default: false) human (boolean): Whether to return version and creation date values in human-readable format. ignore_unavailable (boolean): Ignore unavailable indexes (default: false) include_defaults (boolean): Whether to return all default setting for each of the indices. local (boolean): Return local information, do not retrieve the state from master node (default: false)	[link]
indices.get_alias	GET	/_alias/_alias/{name}/{index}/_alias/{name}/{index}/_alias	index: A comma-separated list of index names to filter aliases name: A comma-separated list of alias names to return		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) local (boolean): Return local information, do not retrieve the state from master node (default: false)	[link]
indices.get_aliases	GET	/_aliases/{index}/_aliases/{index}/_aliases/{name}/_aliases/{name}	index: A comma-separated list of index names to filter aliases name: A comma-separated list of alias names to filter		local (boolean): Return local information, do not retrieve the state from master node (default: false) timeout (time): Explicit operation timeout	[link]
indices.get_field_mapping	GET	/_mapping/field/{fields}/{index}/_mapping/field/{fields}/_mapping/{type}/field/{fields}/{index}/_mapping/{type}/field/{fields}	fields: A comma-separated list of fields index: A comma-separated list of index names type: A comma-separated list of document types		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) include_defaults (boolean): Whether the default mapping values should be returned as well local (boolean): Return local information, do not retrieve the state from master node (default: false)	[link]
indices.get_mapping	GET	/_mapping/{index}/_mapping/_mapping/{type}/{index}/_mapping/{type}	index: A comma-separated list of index names type: A comma-separated list of document types		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) local (boolean): Return local information, do not retrieve the state from master node (default: false)	[link]
indices.get_settings	GET	/_settings/{index}/_settings/{index}/_settings/{name}/_settings/{name}	index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices name: The name of the settings that should be included		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) flat_settings (boolean): Return settings in flat format (default: false) human (boolean): Whether to return version and creation date values in human-readable format. ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) include_defaults (boolean): Whether to return all default setting for each of the indices. local (boolean): Return local information, do not retrieve the state from master node (default: false)	[link]
indices.get_template	GET	/_template/_template/{name}	name: The comma separated names of the index templates		flat_settings (boolean): Return settings in flat format (default: false) local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node	[link]
indices.get_upgrade	GET	/_upgrade/{index}/_upgrade	index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) human (boolean): Whether to return time and byte values in human-readable format. ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed)	[link]
indices.open	POST	/{index}/_open	index: A comma separated list of indices to open		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) master_timeout (time): Specify timeout for connection to master timeout (time): Explicit operation timeout	[link]
indices.put_alias	PUT, POST	/{index}/_alias/{name}/{index}/_aliases/{name}	index: A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. name: The name of the alias to be created or updated	The settings for the alias, such as `routing` or `filter`	master_timeout (time): Specify timeout for connection to master timeout (time): Explicit timestamp for the document	[link]
indices.put_mapping	PUT, POST	/{index}/{type}/_mapping/{index}/_mapping/{type}/_mapping/{type}/{index}/{type}/_mappings/{index}/_mappings/{type}/_mappings/{type}	index: A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. type: The name of the document type	The mapping definition	allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) master_timeout (time): Specify timeout for connection to master timeout (time): Explicit operation timeout update_all_types (boolean): Whether to update the mapping for all fields with the same name across all types or not	[link]
indices.put_settings	PUT	/_settings/{index}/_settings	index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices	The index settings to be updated	allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) flat_settings (boolean): Return settings in flat format (default: false) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) master_timeout (time): Specify timeout for connection to master preserve_existing (boolean): Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`	[link]
indices.put_template	PUT, POST	/_template/{name}	name: The name of the template	The template definition	create (boolean): Whether the index template should only be added if new or can also replace an existing one flat_settings (boolean): Return settings in flat format (default: false) master_timeout (time): Specify timeout for connection to master order (number): The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) timeout (time): Explicit operation timeout	[link]
indices.recovery	GET	/_recovery/{index}/_recovery	index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices		active_only (boolean): Display only those recoveries that are currently on-going detailed (boolean): Whether to display detailed information about shard recovery human (boolean): Whether to return time and byte values in human-readable format.	[link]
indices.refresh	POST, GET	/_refresh/{index}/_refresh	index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) force (boolean): Force a refresh even if not required ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) operation_threading (): TODO: ?	[link]
indices.segments	GET	/_segments/{index}/_segments	index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) human (boolean): Whether to return time and byte values in human-readable format. ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) operation_threading (): TODO: ? verbose (boolean): Includes detailed memory usage by Lucene.	[link]
indices.shard_stores	GET	/_shard_stores/{index}/_shard_stores	index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) operation_threading (): TODO: ? status (list): A comma-separated list of statuses used to filter on shards to get store information for [ green, yellow, red, all ]	[link]
indices.stats	GET	/_stats/_stats/{metric}/{index}/_stats/{index}/_stats/{metric}	index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices metric: Limit the information returned the specific metrics.		completion_fields (list): A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards) fielddata_fields (list): A comma-separated list of fields for `fielddata` index metric (supports wildcards) fields (list): A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards) groups (list): A comma-separated list of search groups for `search` index metric human (boolean): Whether to return time and byte values in human-readable format. level (enum): Return stats aggregated at cluster, index or shard level [ cluster, indices, shards ]( default: true ) types (list): A comma-separated list of document types for the `indexing` index metric	[link]
indices.update_aliases	POST	/_aliases		The definition of `actions` to perform	master_timeout (time): Specify timeout for connection to master timeout (time): Request timeout	[link]
indices.upgrade	POST	/_upgrade/{index}/_upgrade	index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) only_ancient_segments (boolean): If true, only ancient (an older Lucene major release) segments will be upgraded wait_for_completion (boolean): Specify whether the request should block until the all segments are upgraded (default: false)	[link]
indices.validate_query	GET, POST	/_validate/query/{index}/_validate/query/{index}/{type}/_validate/query	index: A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices type: A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types	The query definition specified with the Query DSL	allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) analyze_wildcard (boolean): Specify whether wildcard and prefix queries should be analyzed (default: false) analyzer (string): The analyzer to use for the query string default_operator (enum): The default operator for query string query (AND or OR) [ AND, OR ]( default: true ) df (string): The field to use as default where no field prefix is given in the query string expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) explain (boolean): Return detailed information about the error ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) lenient (boolean): Specify whether format-based query failures (such as providing text to a numeric field) should be ignored lowercase_expanded_terms (boolean): Specify whether query terms should be lowercased operation_threading (): TODO: ? q (string): Query in the Lucene query string syntax rewrite (boolean): Provide a more detailed explanation showing the actual Lucene query that will be executed.	[link]
info	GET	/				[link]
ingest.delete_pipeline	DELETE	/_ingest/pipeline/{id}	id: Pipeline ID		master_timeout (time): Explicit operation timeout for connection to master node timeout (time): Explicit operation timeout	[link]
ingest.get_pipeline	GET	/_ingest/pipeline/{id}	id: Comma separated list of pipeline ids. Wildcards supported		master_timeout (time): Explicit operation timeout for connection to master node	[link]
ingest.put_pipeline	PUT	/_ingest/pipeline/{id}	id: Pipeline ID	The ingest definition	master_timeout (time): Explicit operation timeout for connection to master node timeout (time): Explicit operation timeout	[link]
ingest.simulate	GET, POST	/_ingest/pipeline/_simulate/_ingest/pipeline/{id}/_simulate/	id: Pipeline ID	The simulate definition	verbose (boolean): Verbose mode. Display data output for each processor in executed pipeline	[link]
mget	GET, POST	/_mget/{index}/_mget/{index}/{type}/_mget	index: The name of the index type: The type of the document	Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL.	_source (list): True or false to return the _source field or not, or a list of fields to return _source_exclude (list): A list of fields to exclude from the returned _source field _source_include (list): A list of fields to extract and return from the _source field fields (list): A comma-separated list of fields to return in the response preference (string): Specify the node or shard the operation should be performed on (default: random) realtime (boolean): Specify whether to perform the operation in realtime or search mode refresh (boolean): Refresh the shard containing the document before performing the operation	[link]
mpercolate	GET, POST	/_mpercolate/{index}/_mpercolate/{index}/{type}/_mpercolate	index: The index of the document being count percolated to use as default type: The type of the document being percolated to use as default.	The percolate request definitions (header & body pair), separated by newlines	allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed)	[link]
msearch	GET, POST	/_msearch/{index}/_msearch/{index}/{type}/_msearch	index: A comma-separated list of index names to use as default type: A comma-separated list of document types to use as default	The request definitions (metadata-search request definition pairs), separated by newlines	search_type (enum): Search operation type [ query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch ]	[link]
mtermvectors	GET, POST	/_mtermvectors/{index}/_mtermvectors/{index}/{type}/_mtermvectors	index: The index in which the document resides. type: The type of the document.	Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.	field_statistics (boolean): Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". ( default: true ) fields (list): A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs". ids (list): A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body offsets (boolean): Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". ( default: true ) parent (string): Parent id of documents. Applies to all returned documents unless otherwise specified in body "params" or "docs". payloads (boolean): Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". ( default: true ) positions (boolean): Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". ( default: true ) preference (string): Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs". realtime (boolean): Specifies if requests are real-time as opposed to near-real-time (default: true). routing (string): Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs". term_statistics (boolean): Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". version (number): Explicit version number for concurrency control version_type (enum): Specific version type [ internal, external, external_gte, force ]	[link]
nodes.hot_threads	GET	/_cluster/nodes/hotthreads/_cluster/nodes/hot_threads/_cluster/nodes/{node_id}/hotthreads/_cluster/nodes/{node_id}/hot_threads/_nodes/hotthreads/_nodes/hot_threads/_nodes/{node_id}/hotthreads/_nodes/{node_id}/hot_threads	node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes		ignore_idle_threads (boolean): Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true) interval (time): The interval for the second sampling of threads snapshots (number): Number of samples of thread stacktrace (default: 10) threads (number): Specify the number of threads to provide information for (default: 3) timeout (time): Explicit operation timeout type (enum): The type to sample (default: cpu) [ cpu, wait, block ]	[link]
nodes.info	GET	/_nodes/_nodes/{node_id}/_nodes/{metric}/_nodes/{node_id}/{metric}	metric: A comma-separated list of metrics you wish returned. Leave empty to return all. node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes		flat_settings (boolean): Return settings in flat format (default: false) human (boolean): Whether to return time and byte values in human-readable format. timeout (time): Explicit operation timeout	[link]
nodes.stats	GET	/_nodes/stats/_nodes/{node_id}/stats/_nodes/stats/{metric}/_nodes/{node_id}/stats/{metric}/_nodes/stats/{metric}/{index_metric}/_nodes/{node_id}/stats/{metric}/{index_metric}	index_metric: Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. metric: Limit the information returned to the specified metrics node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes		completion_fields (list): A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards) fielddata_fields (list): A comma-separated list of fields for `fielddata` index metric (supports wildcards) fields (list): A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards) groups (boolean): A comma-separated list of search groups for `search` index metric human (boolean): Whether to return time and byte values in human-readable format. level (enum): Return indices stats aggregated at node, index or shard level [ node, indices, shards ]( default: true ) timeout (time): Explicit operation timeout types (list): A comma-separated list of document types for the `indexing` index metric	[link]
percolate	GET, POST	/{index}/{type}/_percolate/{index}/{type}/{id}/_percolate	id: Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. index: The index of the document being percolated. type: The type of the document being percolated.	The percolator request definition using the percolate DSL	allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) percolate_format (enum): Return an array of matching query IDs instead of objects [ ids ] percolate_index (string): The index to percolate the document into. Defaults to index. percolate_preference (string): Which shard to prefer when executing the percolate request. percolate_routing (string): The routing value to use when percolating the existing document. percolate_type (string): The type to percolate document into. Defaults to type. preference (string): Specify the node or shard the operation should be performed on (default: random) routing (list): A comma-separated list of specific routing values version (number): Explicit version number for concurrency control version_type (enum): Specific version type [ internal, external, external_gte, force ]	[link]
ping	HEAD	/				[link]
put_script	PUT, POST	/_scripts/{lang}/{id}	id: Script ID lang: Script language	The document	op_type (enum): Explicit operation type [ index, create ]( default: true ) version (number): Explicit version number for concurrency control version_type (enum): Specific version type [ internal, external, external_gte, force ]	[link]
put_template	PUT, POST	/_search/template/{id}	id: Template ID	The document	op_type (enum): Explicit operation type [ index, create ]( default: true ) version (number): Explicit version number for concurrency control version_type (enum): Specific version type [ internal, external, external_gte, force ]	[link]
reindex	POST	/_reindex		The search definition using the Query DSL and the prototype for the index request.	consistency (enum): Explicit write consistency setting for the operation [ one, quorum, all ] refresh (boolean): Should the effected indexes be refreshed? requests_per_second (float): The throttle for this request in sub-requests per second. 0 means set no throttle. timeout (time): Time each individual bulk request should wait for shards that are unavailable. ( default: true ) wait_for_completion (boolean): Should the request should block until the reindex is complete.	[link]
render_search_template	GET, POST	/_render/template/_render/template/{id}	id: The id of the stored search template	The search definition template and its params		[link]
scroll	GET, POST	/_search/scroll/_search/scroll/{scroll_id}	scroll_id: The scroll ID	The scroll ID if not passed by URL or query parameter.	scroll (duration): Specify how long a consistent view of the index should be maintained for scrolled search scroll_id (string): The scroll ID for scrolled search	[link]
search	GET, POST	/_search/{index}/_search/{index}/{type}/_search	index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices type: A comma-separated list of document types to search; leave empty to perform the operation on all types	The search definition using the Query DSL	_source (list): True or false to return the _source field or not, or a list of fields to return _source_exclude (list): A list of fields to exclude from the returned _source field _source_include (list): A list of fields to extract and return from the _source field allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) analyze_wildcard (boolean): Specify whether wildcard and prefix queries should be analyzed (default: false) analyzer (string): The analyzer to use for the query string default_operator (enum): The default operator for query string query (AND or OR) [ AND, OR ]( default: true ) df (string): The field to use as default where no field prefix is given in the query string expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) explain (boolean): Specify whether to return detailed information about score computation as part of a hit fielddata_fields (list): A comma-separated list of fields to return as the field data representation of a field for each hit fields (list): A comma-separated list of fields to return as part of a hit from (number): Starting offset (default: 0) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) lenient (boolean): Specify whether format-based query failures (such as providing text to a numeric field) should be ignored lowercase_expanded_terms (boolean): Specify whether query terms should be lowercased preference (string): Specify the node or shard the operation should be performed on (default: random) q (string): Query in the Lucene query string syntax request_cache (boolean): Specify if request cache should be used for this request or not, defaults to index level setting routing (list): A comma-separated list of specific routing values scroll (duration): Specify how long a consistent view of the index should be maintained for scrolled search search_type (enum): Search operation type [ query_then_fetch, dfs_query_then_fetch ] size (number): Number of hits to return (default: 10) sort (list): A comma-separated list of <field>:<direction> pairs stats (list): Specific 'tag' of the request for logging and statistical purposes suggest_field (string): Specify which field to use for suggestions suggest_mode (enum): Specify suggest mode [ missing, popular, always ]( default: true ) suggest_size (number): How many suggestions to return in response suggest_text (text): The source text for which the suggestions should be returned terminate_after (number): The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. timeout (time): Explicit operation timeout track_scores (boolean): Whether to calculate and return scores even if they are not used for sorting version (boolean): Specify whether to return document version as part of a hit	[link]
search_shards	GET, POST	/_search_shards/{index}/_search_shards/{index}/{type}/_search_shards	index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices type: A comma-separated list of document types to search; leave empty to perform the operation on all types		allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) local (boolean): Return local information, do not retrieve the state from master node (default: false) preference (string): Specify the node or shard the operation should be performed on (default: random) routing (string): Specific routing value	[link]
search_template	GET, POST	/_search/template/{index}/_search/template/{index}/{type}/_search/template	index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices type: A comma-separated list of document types to search; leave empty to perform the operation on all types	The search definition template and its params	allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) preference (string): Specify the node or shard the operation should be performed on (default: random) routing (list): A comma-separated list of specific routing values scroll (duration): Specify how long a consistent view of the index should be maintained for scrolled search search_type (enum): Search operation type [ query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch ]	[link]
snapshot.create	PUT, POST	/_snapshot/{repository}/{snapshot}	repository: A repository name snapshot: A snapshot name	The snapshot definition	master_timeout (time): Explicit operation timeout for connection to master node wait_for_completion (boolean): Should this request wait until the operation has completed before returning	[link]
snapshot.create_repository	PUT, POST	/_snapshot/{repository}	repository: A repository name	The repository definition	master_timeout (time): Explicit operation timeout for connection to master node timeout (time): Explicit operation timeout verify (boolean): Whether to verify the repository after creation	[link]
snapshot.delete	DELETE	/_snapshot/{repository}/{snapshot}	repository: A repository name snapshot: A snapshot name		master_timeout (time): Explicit operation timeout for connection to master node	[link]
snapshot.delete_repository	DELETE	/_snapshot/{repository}	repository: A comma-separated list of repository names		master_timeout (time): Explicit operation timeout for connection to master node timeout (time): Explicit operation timeout	[link]
snapshot.get	GET	/_snapshot/{repository}/{snapshot}	repository: A repository name snapshot: A comma-separated list of snapshot names		master_timeout (time): Explicit operation timeout for connection to master node	[link]
snapshot.get_repository	GET	/_snapshot/_snapshot/{repository}	repository: A comma-separated list of repository names		local (boolean): Return local information, do not retrieve the state from master node (default: false) master_timeout (time): Explicit operation timeout for connection to master node	[link]
snapshot.restore	POST	/_snapshot/{repository}/{snapshot}/_restore	repository: A repository name snapshot: A snapshot name	Details of what to restore	master_timeout (time): Explicit operation timeout for connection to master node wait_for_completion (boolean): Should this request wait until the operation has completed before returning	[link]
snapshot.status	GET	/_snapshot/_status/_snapshot/{repository}/_status/_snapshot/{repository}/{snapshot}/_status	repository: A repository name snapshot: A comma-separated list of snapshot names		master_timeout (time): Explicit operation timeout for connection to master node	[link]
snapshot.verify_repository	POST	/_snapshot/{repository}/_verify	repository: A repository name		master_timeout (time): Explicit operation timeout for connection to master node timeout (time): Explicit operation timeout	[link]
suggest	POST, GET	/_suggest/{index}/_suggest	index: A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices	The request definition	allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) preference (string): Specify the node or shard the operation should be performed on (default: random) routing (string): Specific routing value	[link]
tasks.cancel	POST	/_tasks/_cancel/_tasks/{task_id}/_cancel	task_id: Cancel the task with specified id		actions (list): A comma-separated list of actions that should be cancelled. Leave empty to cancel all. node_id (list): A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes parent_node (string): Cancel tasks with specified parent node. parent_task (number): Cancel tasks with specified parent task id. Set to -1 to cancel all.	[link]
tasks.list	GET	/_tasks/_tasks/{task_id}	task_id: Return the task with specified id		actions (list): A comma-separated list of actions that should be returned. Leave empty to return all. detailed (boolean): Return detailed task information (default: false) node_id (list): A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes parent_node (string): Return tasks with specified parent node. parent_task (number): Return tasks with specified parent task id. Set to -1 to return all. wait_for_completion (boolean): Wait for the matching tasks to complete (default: false)	[link]
termvectors	GET, POST	/{index}/{type}/_termvectors/{index}/{type}/{id}/_termvectors	id: The id of the document, when not specified a doc param should be supplied. index: The index in which the document resides. type: The type of the document.	Define parameters and or supply a document to get termvectors for. See documentation.	field_statistics (boolean): Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. ( default: true ) fields (list): A comma-separated list of fields to return. offsets (boolean): Specifies if term offsets should be returned. ( default: true ) parent (string): Parent id of documents. payloads (boolean): Specifies if term payloads should be returned. ( default: true ) positions (boolean): Specifies if term positions should be returned. ( default: true ) preference (string): Specify the node or shard the operation should be performed on (default: random). realtime (boolean): Specifies if request is real-time as opposed to near-real-time (default: true). routing (string): Specific routing value. term_statistics (boolean): Specifies if total term frequency and document frequency should be returned. version (number): Explicit version number for concurrency control version_type (enum): Specific version type [ internal, external, external_gte, force ]	[link]
update-by-query	POST	/{index}/_update_by_query/{index}/{type}/_update_by_query	index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices type: A comma-separated list of document types to search; leave empty to perform the operation on all types	The search definition using the Query DSL	_source (list): True or false to return the _source field or not, or a list of fields to return _source_exclude (list): A list of fields to exclude from the returned _source field _source_include (list): A list of fields to extract and return from the _source field allow_no_indices (boolean): Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) analyze_wildcard (boolean): Specify whether wildcard and prefix queries should be analyzed (default: false) analyzer (string): The analyzer to use for the query string conflicts (enum): What to do when the reindex hits version conflicts? [ abort, proceed ]( default: true ) consistency (enum): Explicit write consistency setting for the operation [ one, quorum, all ] default_operator (enum): The default operator for query string query (AND or OR) [ AND, OR ]( default: true ) df (string): The field to use as default where no field prefix is given in the query string expand_wildcards (enum): Whether to expand wildcard expression to concrete indices that are open, closed or both. [ open, closed, none, all ]( default: true ) explain (boolean): Specify whether to return detailed information about score computation as part of a hit fielddata_fields (list): A comma-separated list of fields to return as the field data representation of a field for each hit fields (list): A comma-separated list of fields to return as part of a hit from (number): Starting offset (default: 0) ignore_unavailable (boolean): Whether specified concrete indices should be ignored when unavailable (missing or closed) lenient (boolean): Specify whether format-based query failures (such as providing text to a numeric field) should be ignored lowercase_expanded_terms (boolean): Specify whether query terms should be lowercased pipeline (string): Ingest pipeline to set on index requests made by this action. (default: none) preference (string): Specify the node or shard the operation should be performed on (default: random) q (string): Query in the Lucene query string syntax refresh (boolean): Should the effected indexes be refreshed? request_cache (boolean): Specify if request cache should be used for this request or not, defaults to index level setting requests_per_second (float): The throttle for this request in sub-requests per second. 0 means set no throttle. routing (list): A comma-separated list of specific routing values scroll (duration): Specify how long a consistent view of the index should be maintained for scrolled search scroll_size (integer): Size on the scroll request powering the update-by-query ( default: 100 ) search_timeout (time): Explicit timeout for each search request. Defaults to no timeout. search_type (enum): Search operation type [ query_then_fetch, dfs_query_then_fetch ] size (number): Number of hits to return (default: 10) sort (list): A comma-separated list of <field>:<direction> pairs stats (list): Specific 'tag' of the request for logging and statistical purposes suggest_field (string): Specify which field to use for suggestions suggest_mode (enum): Specify suggest mode [ missing, popular, always ]( default: true ) suggest_size (number): How many suggestions to return in response suggest_text (text): The source text for which the suggestions should be returned terminate_after (number): The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. timeout (time): Time each individual bulk request should wait for shards that are unavailable. ( default: true ) track_scores (boolean): Whether to calculate and return scores even if they are not used for sorting version (boolean): Specify whether to return document version as part of a hit version_type (boolean): Should the document increment the version number (internal) on hit or not (reindex) wait_for_completion (boolean): Should the request should block until the reindex is complete.	[link]
update	POST	/{index}/{type}/{id}/_update	id: Document ID index: The name of the index type: The type of the document	The request definition using either `script` or partial `doc`	consistency (enum): Explicit write consistency setting for the operation [ one, quorum, all ] fields (list): A comma-separated list of fields to return in the response lang (string): The script language (default: groovy) parent (string): ID of the parent document. Is is only used for routing and when for the upsert request refresh (boolean): Refresh the index after performing the operation retry_on_conflict (number): Specify how many times should the operation be retried when a conflict occurs (default: 0) routing (string): Specific routing value script (): The URL-encoded script definition (instead of using request body) script_id (): The id of a stored script scripted_upsert (boolean): True if the script referenced in script or script_id should be called to perform inserts - defaults to false timeout (time): Explicit operation timeout timestamp (time): Explicit timestamp for the document ttl (duration): Expiration time for the document version (number): Explicit version number for concurrency control version_type (enum): Specific version type [ internal, force ]	[link]

Why? Inspired by ec2instances.info, we needed a simple website with just an overview of all possible calls in Elasticsearch.

Warning: This site is not maintained by or affiliated with Elastic. The data shown is not guaranteed to be accurate or current. Please report issues you see.

Made with  by Dutch Coders (@dutchcoders)