Elasticsearch Request & Response Specification
Elasticsearch Request & Response Specification endpoints from Elastic
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Elasticsearch Request & Response Specification endpoints from Elastic
Endpoints 400
search
- GETGet async search results
/_async_search/:id?keep_alive=string&typed_keys=true&wait_for_completion_timeout=string&return_intermediate_results=trueRetrieve the results of a previously submitted asynchronous search request. If the Elasticsearch security features are enabled, access to the results of a… - DELETEDelete an async search
/_async_search/:idIf the asynchronous search is still running, it is cancelled. Otherwise, the saved search results are deleted. If the Elasticsearch security features are… - GETGet the async search status
/_async_search/status/:id?keep_alive=5dGet the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features… - POSTRun an async search
/_async_search?wait_for_completion_timeout=1s&keep_alive=5d&keep_on_completion=false&allow_no_indices=true&allow_partial_search_results=true&analyzer=string&analyze_wildcard=false&batched_reduce_size=5.0&ccs_minimize_roundtrips=false&default_operator=or&df=string&docvalue_fields=string&expand_wildcards=open&explain=true&ignore_throttled=true&ignore_unavailable=true&lenient=true&max_concurrent_shard_requests=5.0&preference=random&request_cache=true&routing=string&search_type=query_then_fetch&stats=string&stored_fields=string&suggest_field=string&suggest_mode=missing&suggest_size=0.0&suggest_text=string&terminate_after=0.0&timeout=string&track_total_hits=true&track_scores=true&typed_keys=true&rest_total_hits_as_int=false&version=true&_source=true&_source_excludes=string&_source_includes=string&seq_no_primary_term=true&q=string&size=10.0&from=0.0&sort=stringWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results… - POSTRun an async search
/:index/_async_search?wait_for_completion_timeout=1s&keep_alive=5d&keep_on_completion=false&allow_no_indices=true&allow_partial_search_results=true&analyzer=string&analyze_wildcard=false&batched_reduce_size=5.0&ccs_minimize_roundtrips=false&default_operator=or&df=string&docvalue_fields=string&expand_wildcards=open&explain=true&ignore_throttled=true&ignore_unavailable=true&lenient=true&max_concurrent_shard_requests=5.0&preference=random&request_cache=true&routing=string&search_type=query_then_fetch&stats=string&stored_fields=string&suggest_field=string&suggest_mode=missing&suggest_size=0.0&suggest_text=string&terminate_after=0.0&timeout=string&track_total_hits=true&track_scores=true&typed_keys=true&rest_total_hits_as_int=false&version=true&_source=true&_source_excludes=string&_source_includes=string&seq_no_primary_term=true&q=string&size=10.0&from=0.0&sort=stringWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results… - GETRun a scrolling search
/_search/scroll?scroll=1d&scroll_id=string&rest_total_hits_as_int=falseIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use… - POSTRun a scrolling search
/_search/scroll?scroll=1d&scroll_id=string&rest_total_hits_as_int=falseIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use… - DELETEClear a scrolling search
/_search/scrollClear the search context and results for a scrolling search. - GETRun a scrolling search
/_search/scroll/:scroll_id?scroll=1d&scroll_id=string&rest_total_hits_as_int=falseIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use… - POSTRun a scrolling search
/_search/scroll/:scroll_id?scroll=1d&scroll_id=string&rest_total_hits_as_int=falseIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use… - DELETEClear a scrolling search
/_search/scroll/:scroll_idClear the search context and results for a scrolling search. - DELETEClose a point in time
/_pitA point in time must be opened explicitly before being used in search requests. The keep_alive parameter tells Elasticsearch how long it should persist. A… - GETCount search results
/_count?allow_no_indices=true&analyzer=string&analyze_wildcard=false&default_operator=or&df=string&expand_wildcards=open&ignore_throttled=true&ignore_unavailable=false&lenient=false&min_score=0.0&preference=string&routing=string&stats=string&terminate_after=0.0&q=stringGet the number of documents matching a query. The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within… - POSTCount search results
/_count?allow_no_indices=true&analyzer=string&analyze_wildcard=false&default_operator=or&df=string&expand_wildcards=open&ignore_throttled=true&ignore_unavailable=false&lenient=false&min_score=0.0&preference=string&routing=string&stats=string&terminate_after=0.0&q=stringGet the number of documents matching a query. The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within… - GETCount search results
/:index/_count?allow_no_indices=true&analyzer=string&analyze_wildcard=false&default_operator=or&df=string&expand_wildcards=open&ignore_throttled=true&ignore_unavailable=false&lenient=false&min_score=0.0&preference=string&routing=string&stats=string&terminate_after=0.0&q=stringGet the number of documents matching a query. The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within… - POSTCount search results
/:index/_count?allow_no_indices=true&analyzer=string&analyze_wildcard=false&default_operator=or&df=string&expand_wildcards=open&ignore_throttled=true&ignore_unavailable=false&lenient=false&min_score=0.0&preference=string&routing=string&stats=string&terminate_after=0.0&q=stringGet the number of documents matching a query. The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within… - GETExplain a document match result
/:index/_explain/:id?analyzer=string&analyze_wildcard=false&default_operator=or&df=string&lenient=false&preference=string&routing=string&_source=true&_source_excludes=string&_source_includes=string&stored_fields=string&q=stringGet information about why a specific document matches, or doesn't match, a query. It computes a score explanation for a query and a specific document.… - POSTExplain a document match result
/:index/_explain/:id?analyzer=string&analyze_wildcard=false&default_operator=or&df=string&lenient=false&preference=string&routing=string&_source=true&_source_excludes=string&_source_includes=string&stored_fields=string&q=stringGet information about why a specific document matches, or doesn't match, a query. It computes a score explanation for a query and a specific document.… - GETGet the field capabilities
/_field_caps?allow_no_indices=true&expand_wildcards=open&fields=string&ignore_unavailable=false&include_unmapped=false&filters=string&types=string&include_empty_fields=trueGet information about the capabilities of fields among multiple indices. For data streams, the API returns field capabilities among the stream’s backing… - POSTGet the field capabilities
/_field_caps?allow_no_indices=true&expand_wildcards=open&fields=string&ignore_unavailable=false&include_unmapped=false&filters=string&types=string&include_empty_fields=trueGet information about the capabilities of fields among multiple indices. For data streams, the API returns field capabilities among the stream’s backing… - GETGet the field capabilities
/:index/_field_caps?allow_no_indices=true&expand_wildcards=open&fields=string&ignore_unavailable=false&include_unmapped=false&filters=string&types=string&include_empty_fields=trueGet information about the capabilities of fields among multiple indices. For data streams, the API returns field capabilities among the stream’s backing… - POSTGet the field capabilities
/:index/_field_caps?allow_no_indices=true&expand_wildcards=open&fields=string&ignore_unavailable=false&include_unmapped=false&filters=string&types=string&include_empty_fields=trueGet information about the capabilities of fields among multiple indices. For data streams, the API returns field capabilities among the stream’s backing… - GETEvaluate kNN search settings
/:index/_knn_eval?ignore_unavailable=false&allow_no_indices=true&expand_wildcards=open&wait_for_completion=trueEstimate the recall and cost of approximate kNN search configurations on a dense_vector field against a more thorough baseline. The field must use the… - POSTEvaluate kNN search settings
/:index/_knn_eval?ignore_unavailable=false&allow_no_indices=true&expand_wildcards=open&wait_for_completion=trueEstimate the recall and cost of approximate kNN search configurations on a dense_vector field against a more thorough baseline. The field must use the… - GETRun multiple searches
/_msearch?allow_no_indices=true&ccs_minimize_roundtrips=true&expand_wildcards=open&ignore_throttled=false&ignore_unavailable=false&include_named_queries_score=false&index=string&max_concurrent_searches=0.0&max_concurrent_shard_requests=5.0&pre_filter_shard_size=0.0&rest_total_hits_as_int=false&routing=string&search_type=query_then_fetch&typed_keys=trueThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. The structure is as follows: header\n… - POSTRun multiple searches
/_msearch?allow_no_indices=true&ccs_minimize_roundtrips=true&expand_wildcards=open&ignore_throttled=false&ignore_unavailable=false&include_named_queries_score=false&index=string&max_concurrent_searches=0.0&max_concurrent_shard_requests=5.0&pre_filter_shard_size=0.0&rest_total_hits_as_int=false&routing=string&search_type=query_then_fetch&typed_keys=trueThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. The structure is as follows: header\n… - GETRun multiple searches
/:index/_msearch?allow_no_indices=true&ccs_minimize_roundtrips=true&expand_wildcards=open&ignore_throttled=false&ignore_unavailable=false&include_named_queries_score=false&index=string&max_concurrent_searches=0.0&max_concurrent_shard_requests=5.0&pre_filter_shard_size=0.0&rest_total_hits_as_int=false&routing=string&search_type=query_then_fetch&typed_keys=trueThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. The structure is as follows: header\n… - POSTRun multiple searches
/:index/_msearch?allow_no_indices=true&ccs_minimize_roundtrips=true&expand_wildcards=open&ignore_throttled=false&ignore_unavailable=false&include_named_queries_score=false&index=string&max_concurrent_searches=0.0&max_concurrent_shard_requests=5.0&pre_filter_shard_size=0.0&rest_total_hits_as_int=false&routing=string&search_type=query_then_fetch&typed_keys=trueThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. The structure is as follows: header\n… - GETRun multiple templated searches
/_msearch/template?ccs_minimize_roundtrips=true&max_concurrent_searches=0.0&search_type=query_then_fetch&rest_total_hits_as_int=false&typed_keys=falseRun multiple templated searches with a single request. If you are providing a text file or text input to curl, use the --data-binary flag instead of -d to… - POSTRun multiple templated searches
/_msearch/template?ccs_minimize_roundtrips=true&max_concurrent_searches=0.0&search_type=query_then_fetch&rest_total_hits_as_int=false&typed_keys=falseRun multiple templated searches with a single request. If you are providing a text file or text input to curl, use the --data-binary flag instead of -d to… - GETRun multiple templated searches
/:index/_msearch/template?ccs_minimize_roundtrips=true&max_concurrent_searches=0.0&search_type=query_then_fetch&rest_total_hits_as_int=false&typed_keys=falseRun multiple templated searches with a single request. If you are providing a text file or text input to curl, use the --data-binary flag instead of -d to… - POSTRun multiple templated searches
/:index/_msearch/template?ccs_minimize_roundtrips=true&max_concurrent_searches=0.0&search_type=query_then_fetch&rest_total_hits_as_int=false&typed_keys=falseRun multiple templated searches with a single request. If you are providing a text file or text input to curl, use the --data-binary flag instead of -d to… - POSTOpen a point in time
/:index/_pit?keep_alive=string&ignore_unavailable=false&preference=string&routing=string&expand_wildcards=open&allow_partial_search_results=false&max_concurrent_shard_requests=5.0A search request by default runs against the most recent visible data of the target indices, which is called point in time. Elasticsearch pit (point in time)… - GETEvaluate ranked search results
/_rank_eval?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&search_type=query_then_fetchEvaluate the quality of ranked search results over a set of typical search queries. Required authorization * Index privileges: read - POSTEvaluate ranked search results
/_rank_eval?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&search_type=query_then_fetchEvaluate the quality of ranked search results over a set of typical search queries. Required authorization * Index privileges: read - GETEvaluate ranked search results
/:index/_rank_eval?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&search_type=query_then_fetchEvaluate the quality of ranked search results over a set of typical search queries. Required authorization * Index privileges: read - POSTEvaluate ranked search results
/:index/_rank_eval?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&search_type=query_then_fetchEvaluate the quality of ranked search results over a set of typical search queries. Required authorization * Index privileges: read - GETRender a search template
/_render/templateRender a search template as a search request body. Required authorization * Index privileges: read - POSTRender a search template
/_render/templateRender a search template as a search request body. Required authorization * Index privileges: read - GETRender a search template
/_render/template/:idRender a search template as a search request body. Required authorization * Index privileges: read - POSTRender a search template
/_render/template/:idRender a search template as a search request body. Required authorization * Index privileges: read - GETRun a search
/_search?allow_no_indices=true&allow_partial_search_results=true&analyzer=string&analyze_wildcard=false&batched_reduce_size=512.0&ccs_minimize_roundtrips=true&default_operator=or&df=string&docvalue_fields=string&expand_wildcards=open&explain=false&ignore_throttled=true&ignore_unavailable=false&include_named_queries_score=false&lenient=false&max_concurrent_shard_requests=5.0&preference=string&pre_filter_shard_size=0.0&request_cache=true&routing=string&scroll=string&search_type=query_then_fetch&stats=string&stored_fields=string&suggest_field=string&suggest_mode=missing&suggest_size=0.0&suggest_text=string&terminate_after=0.0&timeout=string&track_total_hits=10000&track_scores=false&typed_keys=false&rest_total_hits_as_int=false&version=false&_source=true&_source_excludes=string&_source_exclude_vectors=false&_source_includes=string&seq_no_primary_term=true&q=string&size=10.0&from=0.0&sort=stringGet search hits that match the query defined in the request. You can provide search queries using the q query string parameter or the request body. If both… - POSTRun a search
/_search?allow_no_indices=true&allow_partial_search_results=true&analyzer=string&analyze_wildcard=false&batched_reduce_size=512.0&ccs_minimize_roundtrips=true&default_operator=or&df=string&docvalue_fields=string&expand_wildcards=open&explain=false&ignore_throttled=true&ignore_unavailable=false&include_named_queries_score=false&lenient=false&max_concurrent_shard_requests=5.0&preference=string&pre_filter_shard_size=0.0&request_cache=true&routing=string&scroll=string&search_type=query_then_fetch&stats=string&stored_fields=string&suggest_field=string&suggest_mode=missing&suggest_size=0.0&suggest_text=string&terminate_after=0.0&timeout=string&track_total_hits=10000&track_scores=false&typed_keys=false&rest_total_hits_as_int=false&version=false&_source=true&_source_excludes=string&_source_exclude_vectors=false&_source_includes=string&seq_no_primary_term=true&q=string&size=10.0&from=0.0&sort=stringGet search hits that match the query defined in the request. You can provide search queries using the q query string parameter or the request body. If both… - GETRun a search
/:index/_search?allow_no_indices=true&allow_partial_search_results=true&analyzer=string&analyze_wildcard=false&batched_reduce_size=512.0&ccs_minimize_roundtrips=true&default_operator=or&df=string&docvalue_fields=string&expand_wildcards=open&explain=false&ignore_throttled=true&ignore_unavailable=false&include_named_queries_score=false&lenient=false&max_concurrent_shard_requests=5.0&preference=string&pre_filter_shard_size=0.0&request_cache=true&routing=string&scroll=string&search_type=query_then_fetch&stats=string&stored_fields=string&suggest_field=string&suggest_mode=missing&suggest_size=0.0&suggest_text=string&terminate_after=0.0&timeout=string&track_total_hits=10000&track_scores=false&typed_keys=false&rest_total_hits_as_int=false&version=false&_source=true&_source_excludes=string&_source_exclude_vectors=false&_source_includes=string&seq_no_primary_term=true&q=string&size=10.0&from=0.0&sort=stringGet search hits that match the query defined in the request. You can provide search queries using the q query string parameter or the request body. If both… - POSTRun a search
/:index/_search?allow_no_indices=true&allow_partial_search_results=true&analyzer=string&analyze_wildcard=false&batched_reduce_size=512.0&ccs_minimize_roundtrips=true&default_operator=or&df=string&docvalue_fields=string&expand_wildcards=open&explain=false&ignore_throttled=true&ignore_unavailable=false&include_named_queries_score=false&lenient=false&max_concurrent_shard_requests=5.0&preference=string&pre_filter_shard_size=0.0&request_cache=true&routing=string&scroll=string&search_type=query_then_fetch&stats=string&stored_fields=string&suggest_field=string&suggest_mode=missing&suggest_size=0.0&suggest_text=string&terminate_after=0.0&timeout=string&track_total_hits=10000&track_scores=false&typed_keys=false&rest_total_hits_as_int=false&version=false&_source=true&_source_excludes=string&_source_exclude_vectors=false&_source_includes=string&seq_no_primary_term=true&q=string&size=10.0&from=0.0&sort=stringGet search hits that match the query defined in the request. You can provide search queries using the q query string parameter or the request body. If both… - GETSearch a vector tile
/:index/_mvt/:field/:zoom/:x/:y?exact_bounds=false&extent=4096.0&grid_agg=geotile&grid_precision=8.0&grid_type=grid&size=10000.0&track_total_hits=10000&with_labels=falseSearch a vector tile for geospatial values. Before using this API, you should be familiar with the Mapbox vector tile specification. The API returns results… - POSTSearch a vector tile
/:index/_mvt/:field/:zoom/:x/:y?exact_bounds=false&extent=4096.0&grid_agg=geotile&grid_precision=8.0&grid_type=grid&size=10000.0&track_total_hits=10000&with_labels=falseSearch a vector tile for geospatial values. Before using this API, you should be familiar with the Mapbox vector tile specification. The API returns results… - GETGet the search shards
/_search_shards?allow_no_indices=false&expand_wildcards=open&ignore_unavailable=false&local=false&master_timeout=30s&preference=string&routing=stringGet the indices and shards that a search request would be run against. This information can be useful for working out issues or planning optimizations with… - POSTGet the search shards
/_search_shards?allow_no_indices=false&expand_wildcards=open&ignore_unavailable=false&local=false&master_timeout=30s&preference=string&routing=stringGet the indices and shards that a search request would be run against. This information can be useful for working out issues or planning optimizations with… - GETGet the search shards
/:index/_search_shards?allow_no_indices=false&expand_wildcards=open&ignore_unavailable=false&local=false&master_timeout=30s&preference=string&routing=stringGet the indices and shards that a search request would be run against. This information can be useful for working out issues or planning optimizations with… - POSTGet the search shards
/:index/_search_shards?allow_no_indices=false&expand_wildcards=open&ignore_unavailable=false&local=false&master_timeout=30s&preference=string&routing=stringGet the indices and shards that a search request would be run against. This information can be useful for working out issues or planning optimizations with… - GETRun a search with a search template
/_search/template?allow_no_indices=true&ccs_minimize_roundtrips=true&expand_wildcards=open&explain=false&ignore_throttled=true&ignore_unavailable=false&preference=string&profile=false&routing=string&scroll=string&search_type=query_then_fetch&rest_total_hits_as_int=false&typed_keys=falseRequired authorization * Index privileges: read - POSTRun a search with a search template
/_search/template?allow_no_indices=true&ccs_minimize_roundtrips=true&expand_wildcards=open&explain=false&ignore_throttled=true&ignore_unavailable=false&preference=string&profile=false&routing=string&scroll=string&search_type=query_then_fetch&rest_total_hits_as_int=false&typed_keys=falseRequired authorization * Index privileges: read - GETRun a search with a search template
/:index/_search/template?allow_no_indices=true&ccs_minimize_roundtrips=true&expand_wildcards=open&explain=false&ignore_throttled=true&ignore_unavailable=false&preference=string&profile=false&routing=string&scroll=string&search_type=query_then_fetch&rest_total_hits_as_int=false&typed_keys=falseRequired authorization * Index privileges: read - POSTRun a search with a search template
/:index/_search/template?allow_no_indices=true&ccs_minimize_roundtrips=true&expand_wildcards=open&explain=false&ignore_throttled=true&ignore_unavailable=false&preference=string&profile=false&routing=string&scroll=string&search_type=query_then_fetch&rest_total_hits_as_int=false&typed_keys=falseRequired authorization * Index privileges: read - GETGet terms in an index
/:index/_terms_enumDiscover terms that match a partial string in an index. This API is designed for low-latency look-ups used in auto-complete scenarios. > info > The terms enum… - POSTGet terms in an index
/:index/_terms_enumDiscover terms that match a partial string in an index. This API is designed for low-latency look-ups used in auto-complete scenarios. > info > The terms enum…
document
- PUTBulk index or delete documents
/_bulk?include_source_on_error=true&list_executed_pipelines=false&pipeline=string&refresh=false&routing=string&_source=true&_source_excludes=string&_source_includes=string&timeout=1m&wait_for_active_shards=1&require_alias=false&require_data_stream=falsePerform multiple index, create, delete, and update actions in a single request. This reduces overhead and can greatly increase indexing speed. If the… - POSTBulk index or delete documents
/_bulk?include_source_on_error=true&list_executed_pipelines=false&pipeline=string&refresh=false&routing=string&_source=true&_source_excludes=string&_source_includes=string&timeout=1m&wait_for_active_shards=1&require_alias=false&require_data_stream=falsePerform multiple index, create, delete, and update actions in a single request. This reduces overhead and can greatly increase indexing speed. If the… - PUTBulk index or delete documents
/:index/_bulk?include_source_on_error=true&list_executed_pipelines=false&pipeline=string&refresh=false&routing=string&_source=true&_source_excludes=string&_source_includes=string&timeout=1m&wait_for_active_shards=1&require_alias=false&require_data_stream=falsePerform multiple index, create, delete, and update actions in a single request. This reduces overhead and can greatly increase indexing speed. If the… - POSTBulk index or delete documents
/:index/_bulk?include_source_on_error=true&list_executed_pipelines=false&pipeline=string&refresh=false&routing=string&_source=true&_source_excludes=string&_source_includes=string&timeout=1m&wait_for_active_shards=1&require_alias=false&require_data_stream=falsePerform multiple index, create, delete, and update actions in a single request. This reduces overhead and can greatly increase indexing speed. If the… - PUTCreate a new document in the index
/:index/_create/:id?include_source_on_error=true&pipeline=string&refresh=false&require_alias=false&require_data_stream=false&routing=string&timeout=1m&version=0.0&version_type=internal&wait_for_active_shards=1You can index a new JSON document with the /<target>/_doc/ or /<target>/_create/<_id> APIs Using _create guarantees that the document is indexed only if it… - POSTCreate a new document in the index
/:index/_create/:id?include_source_on_error=true&pipeline=string&refresh=false&require_alias=false&require_data_stream=false&routing=string&timeout=1m&version=0.0&version_type=internal&wait_for_active_shards=1You can index a new JSON document with the /<target>/_doc/ or /<target>/_create/<_id> APIs Using _create guarantees that the document is indexed only if it… - GETGet a document by its ID
/:index/_doc/:id?preference=string&realtime=true&refresh=false&routing=string&_source=true&_source_excludes=string&_source_exclude_vectors=false&_source_includes=string&stored_fields=string&version=0.0&version_type=internalGet a document and its source or stored fields from an index. By default, this API is realtime and is not affected by the refresh rate of the index (when data… - PUTCreate or update a document in an index
/:index/_doc/:id?if_primary_term=0.0&if_seq_no=0.0&include_source_on_error=true&op_type=index&pipeline=string&refresh=false&routing=string&timeout=1m&version=0.0&version_type=internal&wait_for_active_shards=1&require_alias=false&require_data_stream=falseAdd a JSON document to the specified data stream or index and make it searchable. If the target is an index and the document already exists, the request… - POSTCreate or update a document in an index
/:index/_doc/:id?if_primary_term=0.0&if_seq_no=0.0&include_source_on_error=true&op_type=index&pipeline=string&refresh=false&routing=string&timeout=1m&version=0.0&version_type=internal&wait_for_active_shards=1&require_alias=false&require_data_stream=falseAdd a JSON document to the specified data stream or index and make it searchable. If the target is an index and the document already exists, the request… - DELETEDelete a document
/:index/_doc/:id?if_primary_term=0.0&if_seq_no=0.0&refresh=false&routing=string&timeout=1m&version=0.0&version_type=internal&wait_for_active_shards=1Remove a JSON document from the specified index. NOTE: You cannot send deletion requests directly to a data stream. To delete a document in a data stream, you… - HEADCheck a document
/:index/_doc/:id?preference=string&realtime=true&refresh=false&routing=string&_source=true&_source_excludes=string&_source_includes=string&stored_fields=string&version=0.0&version_type=internalVerify that a document exists. For example, check to see if a document with the _id 0 exists: HEAD my-index-000001/_doc/0 If the document exists, the API… - POSTDelete documents
/:index/_delete_by_query?allow_no_indices=true&analyzer=string&analyze_wildcard=false&conflicts=abort&default_operator=or&df=string&expand_wildcards=open&from=0.0&ignore_unavailable=false&lenient=false&max_docs=0.0&preference=string&refresh=false&request_cache=true&requests_per_second=-1.0&routing=string&q=string&scroll=string&scroll_size=1000.0&search_timeout=string&search_type=query_then_fetch&slices=1&sort=string&stats=string&terminate_after=0.0&timeout=1m&version=true&wait_for_active_shards=1&wait_for_completion=trueDeletes documents that match the specified query. If the Elasticsearch security features are enabled, you must have the following index privileges for the… - POSTThrottle a delete by query operation
/_delete_by_query/:task_id/_rethrottle?requests_per_second=0.0Change the number of requests per second for a particular delete by query operation. Rethrottling that speeds up the query takes effect immediately but… - GETGet a document's source
/:index/_source/:id?preference=string&realtime=true&refresh=false&routing=string&_source=true&_source_excludes=string&_source_includes=string&version=0.0&version_type=internalGet the source of a document. For example: GET my-index-000001/_source/1 You can use the source filtering parameters to control which parts of the _source are… - HEADCheck for a document source
/:index/_source/:id?preference=string&realtime=true&refresh=false&routing=string&_source=true&_source_excludes=string&_source_includes=string&version=0.0&version_type=internalCheck whether a document source exists in an index. For example: HEAD my-index-000001/_source/1 A document's source is not available if it is disabled in the… - POSTCreate or update a document in an index
/:index/_doc?if_primary_term=0.0&if_seq_no=0.0&include_source_on_error=true&op_type=index&pipeline=string&refresh=false&routing=string&timeout=1m&version=0.0&version_type=internal&wait_for_active_shards=1&require_alias=false&require_data_stream=falseAdd a JSON document to the specified data stream or index and make it searchable. If the target is an index and the document already exists, the request… - POSTReindex documents
/_reindex?refresh=false&requests_per_second=-1.0&scroll=5m&slices=1&max_docs=0.0&timeout=1m&wait_for_active_shards=1&wait_for_completion=true&require_alias=falseCopy documents from a source to a destination. You can copy all documents to the destination index or reindex a subset of the documents. The source can be any… - GETGet multiple documents
/_mget?preference=string&realtime=true&refresh=false&routing=string&_source=true&_source_excludes=string&_source_includes=string&stored_fields=falseGet multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the… - POSTGet multiple documents
/_mget?preference=string&realtime=true&refresh=false&routing=string&_source=true&_source_excludes=string&_source_includes=string&stored_fields=falseGet multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the… - GETGet multiple documents
/:index/_mget?preference=string&realtime=true&refresh=false&routing=string&_source=true&_source_excludes=string&_source_includes=string&stored_fields=falseGet multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the… - POSTGet multiple documents
/:index/_mget?preference=string&realtime=true&refresh=false&routing=string&_source=true&_source_excludes=string&_source_includes=string&stored_fields=falseGet multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the… - GETGet multiple term vectors
/_mtermvectors?ids=string&fields=string&field_statistics=true&offsets=true&payloads=true&positions=true&preference=string&realtime=true&routing=string&term_statistics=false&version=0.0&version_type=internalGet multiple term vectors with a single request. You can specify existing documents by index and ID or provide artificial documents in the body of the… - POSTGet multiple term vectors
/_mtermvectors?ids=string&fields=string&field_statistics=true&offsets=true&payloads=true&positions=true&preference=string&realtime=true&routing=string&term_statistics=false&version=0.0&version_type=internalGet multiple term vectors with a single request. You can specify existing documents by index and ID or provide artificial documents in the body of the… - GETGet multiple term vectors
/:index/_mtermvectors?ids=string&fields=string&field_statistics=true&offsets=true&payloads=true&positions=true&preference=string&realtime=true&routing=string&term_statistics=false&version=0.0&version_type=internalGet multiple term vectors with a single request. You can specify existing documents by index and ID or provide artificial documents in the body of the… - POSTGet multiple term vectors
/:index/_mtermvectors?ids=string&fields=string&field_statistics=true&offsets=true&payloads=true&positions=true&preference=string&realtime=true&routing=string&term_statistics=false&version=0.0&version_type=internalGet multiple term vectors with a single request. You can specify existing documents by index and ID or provide artificial documents in the body of the… - POSTThrottle a reindex operation
/_reindex/:task_id/_rethrottle?requests_per_second=0.0&group_by=nodesChange the maximum number of documents to index per second for a particular reindex operation. For example, to unthrottle to unlimited documents per second:… - GETGet term vector information
/:index/_termvectors/:id?fields=string&field_statistics=true&offsets=true&payloads=true&positions=true&preference=string&realtime=true&routing=string&term_statistics=false&version=0.0&version_type=internalGet information and statistics about terms in the fields of a particular document. You can retrieve term vectors for documents stored in the index or for… - POSTGet term vector information
/:index/_termvectors/:id?fields=string&field_statistics=true&offsets=true&payloads=true&positions=true&preference=string&realtime=true&routing=string&term_statistics=false&version=0.0&version_type=internalGet information and statistics about terms in the fields of a particular document. You can retrieve term vectors for documents stored in the index or for… - GETGet term vector information
/:index/_termvectors?fields=string&field_statistics=true&offsets=true&payloads=true&positions=true&preference=string&realtime=true&routing=string&term_statistics=false&version=0.0&version_type=internalGet information and statistics about terms in the fields of a particular document. You can retrieve term vectors for documents stored in the index or for… - POSTGet term vector information
/:index/_termvectors?fields=string&field_statistics=true&offsets=true&payloads=true&positions=true&preference=string&realtime=true&routing=string&term_statistics=false&version=0.0&version_type=internalGet information and statistics about terms in the fields of a particular document. You can retrieve term vectors for documents stored in the index or for… - POSTUpdate a document
/:index/_update/:id?if_primary_term=0.0&if_seq_no=0.0&include_source_on_error=true&lang=painless&refresh=false&require_alias=false&retry_on_conflict=0.0&routing=string&timeout=1m&wait_for_active_shards=1&_source=true&_source_excludes=string&_source_includes=stringUpdate a document by running a script or passing a partial document. If the Elasticsearch security features are enabled, you must have the index or write… - POSTUpdate documents
/:index/_update_by_query?allow_no_indices=true&analyzer=string&analyze_wildcard=false&conflicts=abort&default_operator=or&df=string&expand_wildcards=open&from=0.0&ignore_unavailable=false&lenient=false&max_docs=0.0&pipeline=string&preference=string&q=string&refresh=false&request_cache=true&requests_per_second=-1.0&routing=string&scroll=5m&scroll_size=1000.0&search_timeout=string&search_type=query_then_fetch&slices=1&sort=string&stats=string&terminate_after=0.0&timeout=1m&version=true&version_type=true&wait_for_active_shards=1&wait_for_completion=trueUpdates documents that match the specified query. If no query is specified, performs an update on every document in the data stream or index without modifying… - POSTThrottle an update by query operation
/_update_by_query/:task_id/_rethrottle?requests_per_second=0.0Change the number of requests per second for a particular update by query operation. Rethrottling that speeds up the query takes effect immediately but…
reindex
- POSTCancel an ongoing reindex task
/_reindex/:task_id/_cancel?wait_for_completion=trueIf wait_for_completion is true (the default), the response contains the final task state after cancellation. If wait_for_completion is false, the response… - GETGet the status and progress of a specific reindex task
/_reindex/:task_id?wait_for_completion=false&timeout=30sThis API follows reindex tasks across node-shutdown relocations, so callers can keep using the original task ID throughout the lifetime of the operation.… - GETGet information about all currently running reindex tasks
/_reindex?detailed=falseReindex tasks that are mid-relocation between nodes are reported once, under their original task ID, so callers do not see duplicates across the relocation…
cat
- GETGet a compact list of aliases
/_cat/aliases?h=alias&s=string&expand_wildcards=all&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet the cluster's index aliases, including filter and routing information. This API does not return data stream aliases. IMPORTANT: CAT APIs are only intended… - GETGet a compact list of aliases
/_cat/aliases/:name?h=alias&s=string&expand_wildcards=all&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet the cluster's index aliases, including filter and routing information. This API does not return data stream aliases. IMPORTANT: CAT APIs are only intended… - GETGet shard allocation information
/_cat/allocation?h=shards&s=string&local=false&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: CAT APIs are only intended for human consumption using the… - GETGet shard allocation information
/_cat/allocation/:node_id?h=shards&s=string&local=false&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: CAT APIs are only intended for human consumption using the… - GETGet circuit breakers statistics
/_cat/circuit_breaker?h=node_id&s=string&local=false&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. Required… - GETGet circuit breakers statistics
/_cat/circuit_breaker/:circuit_breaker_patterns?h=node_id&s=string&local=false&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. Required… - GETGet a compact list of component templates
/_cat/component_templates?h=name&s=string&local=false&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings,… - GETGet a compact list of component templates
/_cat/component_templates/:name?h=name&s=string&local=false&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings,… - GETGet a document count
/_cat/count?h=epoch&s=string&format=text&help=false&v=false&bytes=b&time=nanosGet quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents… - POSTGet a document count
/_cat/count?h=epoch&s=string&format=text&help=false&v=false&bytes=b&time=nanosGet quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents… - GETGet a document count
/_cat/count/:index?h=epoch&s=string&format=text&help=false&v=false&bytes=b&time=nanosGet quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents… - POSTGet a document count
/_cat/count/:index?h=epoch&s=string&format=text&help=false&v=false&bytes=b&time=nanosGet quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents… - GETGet field data cache information
/_cat/fielddata?fields=string&h=id&s=string&format=text&help=false&v=false&bytes=b&time=nanosGet the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human… - GETGet field data cache information
/_cat/fielddata/:fields?fields=string&h=id&s=string&format=text&help=false&v=false&bytes=b&time=nanosGet the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human… - GETGet a compact cluster health summary
/_cat/health?ts=true&h=epoch&s=string&format=text&help=false&v=false&bytes=b&time=nanosIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For… - GETGet CAT help
/_catGet help for the CAT APIs. - GETGet a compact list of indices
/_cat/indices?expand_wildcards=open,closed&health=green&include_unloaded_segments=false&pri=false&master_timeout=30s&h=health&s=string&format=text&help=false&v=false&bytes=b&time=nanosGet high-level information about indices in a cluster, including backing indices for data streams. Use this request to get the following information for each… - GETGet a compact list of indices
/_cat/indices/:index?expand_wildcards=open,closed&health=green&include_unloaded_segments=false&pri=false&master_timeout=30s&h=health&s=string&format=text&help=false&v=false&bytes=b&time=nanosGet high-level information about indices in a cluster, including backing indices for data streams. Use this request to get the following information for each… - GETGet master node information
/_cat/master?h=id&s=string&local=false&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the… - GETGet data frame analytics jobs
/_cat/ml/data_frame/analytics?allow_no_match=false&h=create_time,id,state,type&s=assignment_explanation&format=text&help=false&v=false&bytes=b&time=nanosGet configuration and usage information about data frame analytics jobs. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console… - GETGet data frame analytics jobs
/_cat/ml/data_frame/analytics/:id?allow_no_match=false&h=create_time,id,state,type&s=assignment_explanation&format=text&help=false&v=false&bytes=b&time=nanosGet configuration and usage information about data frame analytics jobs. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console… - GETGet datafeeds
/_cat/ml/datafeeds?allow_no_match=true&h=id,state,buckets.count,search.count&s=ae&format=text&help=false&v=false&bytes=b&time=nanosGet configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled,… - GETGet datafeeds
/_cat/ml/datafeeds/:datafeed_id?allow_no_match=true&h=id,state,buckets.count,search.count&s=ae&format=text&help=false&v=false&bytes=b&time=nanosGet configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled,… - GETGet anomaly detection jobs
/_cat/ml/anomaly_detectors?allow_no_match=true&h=buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state&s=assignment_explanation&format=text&help=false&v=false&bytes=b&time=nanosGet configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are… - GETGet anomaly detection jobs
/_cat/ml/anomaly_detectors/:job_id?allow_no_match=true&h=buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state&s=assignment_explanation&format=text&help=false&v=false&bytes=b&time=nanosGet configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are… - GETGet trained models
/_cat/ml/trained_models?allow_no_match=true&h=create_time&s=create_time&from=0.0&size=100.0&format=text&help=false&v=false&bytes=b&time=nanosGet configuration and usage information about inference trained models. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console… - GETGet trained models
/_cat/ml/trained_models/:model_id?allow_no_match=true&h=create_time&s=create_time&from=0.0&size=100.0&format=text&help=false&v=false&bytes=b&time=nanosGet configuration and usage information about inference trained models. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console… - GETGet node attribute information
/_cat/nodeattrs?h=node&s=string&local=false&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are… - GETGet a compact list of nodes
/_cat/nodes?full_id=false&include_unloaded_segments=false&h=ip,heap.percent,ram.percent,cpu,load_1m,load_5m,load_15m,node.role,master,name&s=string&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are… - GETGet pending task information
/_cat/pending_tasks?h=insertOrder&s=string&local=false&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet information about cluster-level changes that have not yet taken effect. IMPORTANT: cat APIs are only intended for human consumption using the command line… - GETGet plugin information
/_cat/plugins?h=id&s=string&include_bootstrap=false&local=false&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.… - GETGet shard recovery information
/_cat/recovery?active_only=false&detailed=false&index=string&h=index&s=string&format=text&help=false&v=false&bytes=b&time=nanosGet information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard… - GETGet shard recovery information
/_cat/recovery/:index?active_only=false&detailed=false&index=string&h=index&s=string&format=text&help=false&v=false&bytes=b&time=nanosGet information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard… - GETGet a compact list of snapshot repositories
/_cat/repositories?h=string&s=string&local=false&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet a list of snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They… - GETGet segment information
/_cat/segments?h=index,shard,prirep,ip,segment,generation,docs.count,docs.deleted,size,size.memory,committed,searchable,version,compound&s=string&local=false&master_timeout=30s&expand_wildcards=open&allow_no_indices=true&ignore_throttled=false&ignore_unavailable=false&allow_closed=false&format=text&help=false&v=false&bytes=b&time=nanosGet low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat… - GETGet segment information
/_cat/segments/:index?h=index,shard,prirep,ip,segment,generation,docs.count,docs.deleted,size,size.memory,committed,searchable,version,compound&s=string&local=false&master_timeout=30s&expand_wildcards=open&allow_no_indices=true&ignore_throttled=false&ignore_unavailable=false&allow_closed=false&format=text&help=false&v=false&bytes=b&time=nanosGet low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat… - GETGet shard information
/_cat/shards?h=completion.size&s=string&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended… - GETGet shard information
/_cat/shards/:index?h=completion.size&s=string&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended… - GETGet a compact list of snapshots
/_cat/snapshots?ignore_unavailable=false&h=id,repository,status,start_epoch,start_time,end_epoch,end_time,duration,indices,successful_shards,failed_shards,total_shards&s=string&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat… - GETGet a compact list of snapshots
/_cat/snapshots/:repository?ignore_unavailable=false&h=id,repository,status,start_epoch,start_time,end_epoch,end_time,duration,indices,successful_shards,failed_shards,total_shards&s=string&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat… - GETGet a compact list of running tasks
/_cat/tasks?actions=string&detailed=false&nodes=string&parent_task_id=string&h=id&s=string&timeout=30s&wait_for_completion=false&format=text&help=false&v=false&bytes=b&time=nanosGet information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana… - GETGet index template information
/_cat/templates?h=name&s=string&local=false&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation.… - GETGet index template information
/_cat/templates/:name?h=name&s=string&local=false&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation.… - GETGet thread pool statistics
/_cat/thread_pool?h=active&s=string&local=false&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs… - GETGet thread pool statistics
/_cat/thread_pool/:thread_pool_patterns?h=active&s=string&local=false&master_timeout=30s&format=text&help=false&v=false&bytes=b&time=nanosGet thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs… - GETGet transform information
/_cat/transforms?allow_no_match=true&from=0.0&h=changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state&s=changes_last_detection_time&size=100.0&format=text&help=false&v=false&bytes=b&time=nanosGet configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are… - GETGet transform information
/_cat/transforms/:transform_id?allow_no_match=true&from=0.0&h=changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state&s=changes_last_detection_time&size=100.0&format=text&help=false&v=false&bytes=b&time=nanosGet configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are…
ccr
- GETGet auto-follow patterns
/_ccr/auto_follow/:name?master_timeout=30sGet cross-cluster replication auto-follow patterns. Required authorization * Cluster privileges: manage_ccr - PUTCreate or update auto-follow patterns
/_ccr/auto_follow/:name?master_timeout=30sCreate a collection of cross-cluster replication auto-follow patterns for a remote cluster. Newly created indices on the remote cluster that match any of the… - DELETEDelete auto-follow patterns
/_ccr/auto_follow/:name?master_timeout=30sDelete a collection of cross-cluster replication auto-follow patterns. Required authorization * Cluster privileges: manage_ccr - PUTCreate a follower
/:index/_ccr/follow?master_timeout=30s&wait_for_active_shards=0Create a cross-cluster replication follower index that follows a specific leader index. When the API returns, the follower index exists and cross-cluster… - GETGet follower information
/:index/_ccr/info?master_timeout=30sGet information about all cross-cluster replication follower indices. For example, the results include follower index names, leader index names, replication… - GETGet follower stats
/:index/_ccr/stats?timeout=30sGet cross-cluster replication follower stats. The API returns shard-level stats about the "following tasks" associated with each shard for the specified… - POSTForget a follower
/:index/_ccr/forget_follower?timeout=30sRemove the cross-cluster replication follower retention leases from the leader. A following index takes out retention leases on its leader index. These leases… - GETGet auto-follow patterns
/_ccr/auto_follow?master_timeout=30sGet cross-cluster replication auto-follow patterns. Required authorization * Cluster privileges: manage_ccr - POSTPause an auto-follow pattern
/_ccr/auto_follow/:name/pause?master_timeout=30sPause a cross-cluster replication auto-follow pattern. When the API returns, the auto-follow pattern is inactive. New indices that are created on the remote… - POSTPause a follower
/:index/_ccr/pause_follow?master_timeout=30sPause a cross-cluster replication follower index. The follower index will not fetch any additional operations from the leader index. You can resume following… - POSTResume an auto-follow pattern
/_ccr/auto_follow/:name/resume?master_timeout=30sResume a cross-cluster replication auto-follow pattern that was paused. The auto-follow pattern will resume configuring following indices for newly created… - POSTResume a follower
/:index/_ccr/resume_follow?master_timeout=30sResume a cross-cluster replication follower index that was paused. The follower index could have been paused with the pause follower API. Alternatively it… - GETGet cross-cluster replication stats
/_ccr/stats?master_timeout=30s&timeout=30sThis API returns stats about auto-following and the same shard-level stats as the get follower stats API. Required authorization * Cluster privileges: monitor - POSTUnfollow an index
/:index/_ccr/unfollow?master_timeout=30sConvert a cross-cluster replication follower index to a regular index. The API stops the following task associated with a follower index and removes index…
cluster
- GETExplain the shard allocations
/_cluster/allocation/explain?index=string&shard=0.0&primary=true¤t_node=string&include_disk_info=false&include_yes_decisions=false&master_timeout=30sGet explanations for shard allocations in the cluster. This API accepts the current_node, index, primary and shard parameters in the request body or in query… - POSTExplain the shard allocations
/_cluster/allocation/explain?index=string&shard=0.0&primary=true¤t_node=string&include_disk_info=false&include_yes_decisions=false&master_timeout=30sGet explanations for shard allocations in the cluster. This API accepts the current_node, index, primary and shard parameters in the request body or in query… - POSTUpdate voting configuration exclusions
/_cluster/voting_config_exclusions?node_names=string&node_ids=string&master_timeout=30s&timeout=30sUpdate the cluster voting config exclusions by node IDs or node names. By default, if there are more than three master-eligible nodes in the cluster and you… - DELETEClear cluster voting config exclusions
/_cluster/voting_config_exclusions?master_timeout=30s&wait_for_removal=trueRemove master-eligible nodes from the voting configuration exclusion list. Required authorization * Cluster privileges: manage - GETGet cluster-wide settings
/_cluster/settings?flat_settings=false&include_defaults=false&master_timeout=30s&timeout=30sBy default, it returns only settings that have been explicitly defined. Required authorization * Cluster privileges: monitor - PUTUpdate the cluster settings
/_cluster/settings?flat_settings=false&master_timeout=30s&timeout=30sConfigure and update dynamic settings on a running cluster. You can also configure dynamic settings locally on an unstarted or shut down node in… - GETGet the cluster health status
/_cluster/health?expand_wildcards=all&level=cluster&local=false&master_timeout=30s&timeout=30s&wait_for_active_shards=0&wait_for_events=immediate&wait_for_nodes=string&wait_for_no_initializing_shards=false&wait_for_no_relocating_shards=false&wait_for_status=greenYou can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the… - GETGet the cluster health status
/_cluster/health/:index?expand_wildcards=all&level=cluster&local=false&master_timeout=30s&timeout=30s&wait_for_active_shards=0&wait_for_events=immediate&wait_for_nodes=string&wait_for_no_initializing_shards=false&wait_for_no_relocating_shards=false&wait_for_status=greenYou can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the… - GETGet cluster subsystem info
/_info/:targetReturns basic information about the cluster. Required authorization * Cluster privileges: monitor - GETGet the pending cluster tasks
/_cluster/pending_tasks?local=false&master_timeout=30sGet information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. NOTE: This API… - GETGet remote cluster information
/_remote/infoGet information about configured remote clusters. The API returns connection and endpoint information keyed by the configured remote cluster alias. > info >… - POSTReroute the cluster
/_cluster/reroute?dry_run=false&explain=false&metric=string&retry_failed=false&master_timeout=30s&timeout=30sManually change the allocation of individual shards in the cluster. For example, a shard can be moved from one node to another explicitly, an allocation can… - GETGet the cluster state
/_cluster/state?allow_no_indices=true&expand_wildcards=open&flat_settings=false&ignore_unavailable=false&local=false&master_timeout=30s&wait_for_metadata_version=0.0&wait_for_timeout=stringGet comprehensive information about the state of the cluster. The cluster state is an internal data structure which keeps track of a variety of information… - GETGet the cluster state
/_cluster/state/:metric?allow_no_indices=true&expand_wildcards=open&flat_settings=false&ignore_unavailable=false&local=false&master_timeout=30s&wait_for_metadata_version=0.0&wait_for_timeout=stringGet comprehensive information about the state of the cluster. The cluster state is an internal data structure which keeps track of a variety of information… - GETGet the cluster state
/_cluster/state/:metric/:index?allow_no_indices=true&expand_wildcards=open&flat_settings=false&ignore_unavailable=false&local=false&master_timeout=30s&wait_for_metadata_version=0.0&wait_for_timeout=stringGet comprehensive information about the state of the cluster. The cluster state is an internal data structure which keeps track of a variety of information… - GETGet cluster statistics
/_cluster/stats?include_remotes=false&timeout=stringGet basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm… - GETGet cluster statistics
/_cluster/stats/nodes/:node_id?include_remotes=false&timeout=stringGet basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm… - HEADPing the cluster
/Get information about whether the cluster is running. - DELETEClear the archived repositories metering
/_nodes/:node_id/_repositories_metering/:max_archive_versionClear the archived repositories metering information in the cluster. Required authorization * Cluster privileges: monitor,manage - GETGet cluster repositories metering
/_nodes/:node_id/_repositories_meteringGet repositories metering information for a cluster. This API exposes monotonically non-decreasing counters and it is expected that clients would durably… - GETGet the hot threads for nodes
/_nodes/hot_threads?ignore_idle_threads=true&interval=500ms&snapshots=10.0&threads=3.0&timeout=30s&type=cpu&sort=totalGet a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node.… - GETGet the hot threads for nodes
/_nodes/:node_id/hot_threads?ignore_idle_threads=true&interval=500ms&snapshots=10.0&threads=3.0&timeout=30s&type=cpu&sort=totalGet a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node.… - GETGet node information
/_nodes?flat_settings=false&timeout=30sBy default, the API returns all attributes and core settings for cluster nodes. Required authorization * Cluster privileges: monitor,manage - GETGet node information
/_nodes/:node_id?flat_settings=false&timeout=30sBy default, the API returns all attributes and core settings for cluster nodes. Required authorization * Cluster privileges: monitor,manage - GETGet node information
/_nodes/:metric?flat_settings=false&timeout=30sBy default, the API returns all attributes and core settings for cluster nodes. Required authorization * Cluster privileges: monitor,manage - GETGet node information
/_nodes/:node_id/:metric?flat_settings=false&timeout=30sBy default, the API returns all attributes and core settings for cluster nodes. Required authorization * Cluster privileges: monitor,manage - POSTReload the keystore on nodes in the cluster
/_nodes/reload_secure_settings?timeout=30sSecure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without… - POSTReload the keystore on nodes in the cluster
/_nodes/:node_id/reload_secure_settings?timeout=30sSecure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without… - GETGet node statistics
/_nodes/stats?completion_fields=string&fielddata_fields=string&fields=string&groups=true&include_segment_file_sizes=false&level=node&timeout=30s&types=string&include_unloaded_segments=falseGet statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. Required authorization *… - GETGet node statistics
/_nodes/:node_id/stats?completion_fields=string&fielddata_fields=string&fields=string&groups=true&include_segment_file_sizes=false&level=node&timeout=30s&types=string&include_unloaded_segments=falseGet statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. Required authorization *… - GETGet node statistics
/_nodes/stats/:metric?completion_fields=string&fielddata_fields=string&fields=string&groups=true&include_segment_file_sizes=false&level=node&timeout=30s&types=string&include_unloaded_segments=falseGet statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. Required authorization *… - GETGet node statistics
/_nodes/:node_id/stats/:metric?completion_fields=string&fielddata_fields=string&fields=string&groups=true&include_segment_file_sizes=false&level=node&timeout=30s&types=string&include_unloaded_segments=falseGet statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. Required authorization *… - GETGet node statistics
/_nodes/stats/:metric/:index_metric?completion_fields=string&fielddata_fields=string&fields=string&groups=true&include_segment_file_sizes=false&level=node&timeout=30s&types=string&include_unloaded_segments=falseGet statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. Required authorization *… - GETGet node statistics
/_nodes/:node_id/stats/:metric/:index_metric?completion_fields=string&fielddata_fields=string&fields=string&groups=true&include_segment_file_sizes=false&level=node&timeout=30s&types=string&include_unloaded_segments=falseGet statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. Required authorization *… - GETGet feature usage information
/_nodes/usage?timeout=30sRequired authorization * Cluster privileges: monitor,manage - GETGet feature usage information
/_nodes/:node_id/usage?timeout=30sRequired authorization * Cluster privileges: monitor,manage - GETGet feature usage information
/_nodes/usage/:metric?timeout=30sRequired authorization * Cluster privileges: monitor,manage - GETGet feature usage information
/_nodes/:node_id/usage/:metric?timeout=30sRequired authorization * Cluster privileges: monitor,manage
indices
- GETGet component templates
/_component_template/:name?flat_settings=false&settings_filter=string&include_defaults=false&local=false&master_timeout=30sGet information about component templates. Required authorization * Cluster privileges: manage_index_templates - PUTCreate or update a component template
/_component_template/:name?create=false&cause=api&master_timeout=30sComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. An index template can be composed… - POSTCreate or update a component template
/_component_template/:name?create=false&cause=api&master_timeout=30sComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. An index template can be composed… - DELETEDelete component templates
/_component_template/:name?master_timeout=30s&timeout=30sComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. Required authorization * Cluster… - HEADCheck component templates
/_component_template/:name?master_timeout=30s&local=falseReturns information about whether a particular component template exists. Required authorization * Cluster privileges: monitor,manage_index_templates - GETGet component templates
/_component_template?flat_settings=false&settings_filter=string&include_defaults=false&local=false&master_timeout=30sGet information about component templates. Required authorization * Cluster privileges: manage_index_templates - POSTImport a dangling index
/_dangling/:index_uuid?accept_data_loss=false&master_timeout=30s&timeout=30sIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can… - DELETEDelete a dangling index
/_dangling/:index_uuid?accept_data_loss=false&master_timeout=30s&timeout=30sIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can… - GETGet the dangling indices
/_danglingIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can… - PUTAdd an index block
/:index/_block/:block?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&master_timeout=30s&timeout=30sAdd an index block to an index. Index blocks limit the operations allowed on an index by blocking specific operation types. Required authorization * Index… - DELETERemove an index block
/:index/_block/:block?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&master_timeout=30s&timeout=30sRemove an index block from an index. Index blocks limit the operations allowed on an index by blocking specific operation types. Required authorization *… - GETGet tokens from text analysis
/_analyze?index=stringThe analyze API performs analysis on a text string and returns the resulting tokens. Generating excessive amount of tokens may cause a node to run out of… - POSTGet tokens from text analysis
/_analyze?index=stringThe analyze API performs analysis on a text string and returns the resulting tokens. Generating excessive amount of tokens may cause a node to run out of… - GETGet tokens from text analysis
/:index/_analyze?index=stringThe analyze API performs analysis on a text string and returns the resulting tokens. Generating excessive amount of tokens may cause a node to run out of… - POSTGet tokens from text analysis
/:index/_analyze?index=stringThe analyze API performs analysis on a text string and returns the resulting tokens. Generating excessive amount of tokens may cause a node to run out of… - POSTClear the cache
/_cache/clear?index=string&allow_no_indices=true&expand_wildcards=open&fielddata=true&fields=string&ignore_unavailable=false&query=true&request=trueClear the cache of one or more indices. For data streams, the API clears the caches of the stream's backing indices. By default, the clear cache API clears… - POSTClear the cache
/:index/_cache/clear?index=string&allow_no_indices=true&expand_wildcards=open&fielddata=true&fields=string&ignore_unavailable=false&query=true&request=trueClear the cache of one or more indices. For data streams, the API clears the caches of the stream's backing indices. By default, the clear cache API clears… - PUTClone an index
/:index/_clone/:target?master_timeout=30s&timeout=30s&wait_for_active_shards=1Clone an existing index into a new index. Each original primary shard is cloned into a new primary shard in the new index. IMPORTANT: Elasticsearch does not… - POSTClone an index
/:index/_clone/:target?master_timeout=30s&timeout=30s&wait_for_active_shards=1Clone an existing index into a new index. Each original primary shard is cloned into a new primary shard in the new index. IMPORTANT: Elasticsearch does not… - POSTClose an index
/:index/_close?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&master_timeout=30s&timeout=30s&wait_for_active_shards=1A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. It is not possible to index documents or… - GETGet index information
/:index?allow_no_indices=true&expand_wildcards=open&flat_settings=false&ignore_unavailable=false&include_defaults=false&local=false&master_timeout=30s&features=['aliases', 'mappings', 'settings']Get information about one or more indices. For data streams, the API returns information about the stream’s backing indices. Required authorization * Index… - PUTCreate an index
/:index?master_timeout=30s&timeout=30s&wait_for_active_shards=1You can use the create index API to add a new index to an Elasticsearch cluster. When creating an index, you can specify the following: * Settings for the… - DELETEDelete indices
/:index?allow_no_indices=true&expand_wildcards=open,closed&ignore_unavailable=false&master_timeout=30s&timeout=30sDeleting an index deletes its documents, shards, and metadata. It does not delete related Kibana components, such as data views, visualizations, or… - HEADCheck indices
/:index?allow_no_indices=true&expand_wildcards=open&flat_settings=false&ignore_unavailable=false&include_defaults=false&local=falseCheck if one or more indices, index aliases, or data streams exist. Required authorization * Index privileges: view_index_metadata,manage - GETGet aliases
/:index/_alias/:name?allow_no_indices=true&expand_wildcards=all&ignore_unavailable=false&master_timeout=30sRetrieves information for one or more data stream or index aliases. Required authorization * Index privileges: view_index_metadata - PUTCreate or update an alias
/:index/_alias/:name?master_timeout=30s&timeout=30sAdds a data stream or index to an alias. Required authorization * Index privileges: manage - POSTCreate or update an alias
/:index/_alias/:name?master_timeout=30s&timeout=30sAdds a data stream or index to an alias. Required authorization * Index privileges: manage - DELETEDelete an alias
/:index/_alias/:name?master_timeout=30s&timeout=30sRemoves a data stream or index from an alias. Required authorization * Index privileges: manage - HEADCheck aliases
/:index/_alias/:name?allow_no_indices=true&expand_wildcards=all&ignore_unavailable=false&master_timeout=30sCheck if one or more data stream or index aliases exist. Required authorization * Index privileges: view_index_metadata,manage - PUTCreate or update an alias
/:index/_aliases/:name?master_timeout=30s&timeout=30sAdds a data stream or index to an alias. Required authorization * Index privileges: manage - POSTCreate or update an alias
/:index/_aliases/:name?master_timeout=30s&timeout=30sAdds a data stream or index to an alias. Required authorization * Index privileges: manage - DELETEDelete an alias
/:index/_aliases/:name?master_timeout=30s&timeout=30sRemoves a data stream or index from an alias. Required authorization * Index privileges: manage - DELETEDelete data stream lifecycles
/_data_stream/:name/_lifecycle?expand_wildcards=open&master_timeout=30s&timeout=30sRemoves the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. Required authorization * Index privileges:… - GETGet index templates
/_index_template/:name?local=false&flat_settings=false&master_timeout=30s&include_defaults=false&include_managed_fields=falseGet information about one or more index templates. Required authorization * Cluster privileges: manage_index_templates - PUTCreate or update an index template
/_index_template/:name?create=false&master_timeout=30s&cause=apiIndex templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based… - POSTCreate or update an index template
/_index_template/:name?create=false&master_timeout=30s&cause=apiIndex templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based… - DELETEDelete an index template
/_index_template/:name?master_timeout=30s&timeout=30sThe provided <index-template> may contain multiple template names separated by a comma. If multiple template names are specified then there is no wildcard… - HEADCheck index templates
/_index_template/:name?local=false&flat_settings=false&master_timeout=30sCheck whether index templates exist. Required authorization * Cluster privileges: manage_index_templates - GETGet legacy index templates
/_template/:name?flat_settings=false&local=false&master_timeout=30sDeprecated. Get information about one or more index templates. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be… - PUTCreate or update a legacy index template
/_template/:name?create=false&master_timeout=30s&order=0.0&cause=stringDeprecated. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new… - POSTCreate or update a legacy index template
/_template/:name?create=false&master_timeout=30s&order=0.0&cause=stringDeprecated. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new… - DELETEDelete a legacy index template
/_template/:name?master_timeout=30s&timeout=30sDeprecated. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in… - HEADCheck existence of index templates
/_template/:name?flat_settings=false&local=false&master_timeout=30sGet information about whether index templates exist. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.… - POSTAnalyze the index disk usage
/:index/_disk_usage?allow_no_indices=true&expand_wildcards=open&flush=true&ignore_unavailable=false&run_expensive_tasks=falseAnalyze the disk usage of each field of an index or data stream. This API might not support indices created in previous Elasticsearch versions. The result of… - GETGet aliases
/_alias/:name?allow_no_indices=true&expand_wildcards=all&ignore_unavailable=false&master_timeout=30sRetrieves information for one or more data stream or index aliases. Required authorization * Index privileges: view_index_metadata - HEADCheck aliases
/_alias/:name?allow_no_indices=true&expand_wildcards=all&ignore_unavailable=false&master_timeout=30sCheck if one or more data stream or index aliases exist. Required authorization * Index privileges: view_index_metadata,manage - GETGet field usage stats
/:index/_field_usage_stats?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&fields=stringGet field usage information for each shard and field of an index. Field usage statistics are automatically captured when queries are running on a cluster. A… - GETFlush data streams or indices
/_flush?allow_no_indices=true&expand_wildcards=open&force=true&ignore_unavailable=false&wait_if_ongoing=trueFlushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in… - POSTFlush data streams or indices
/_flush?allow_no_indices=true&expand_wildcards=open&force=true&ignore_unavailable=false&wait_if_ongoing=trueFlushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in… - GETFlush data streams or indices
/:index/_flush?allow_no_indices=true&expand_wildcards=open&force=true&ignore_unavailable=false&wait_if_ongoing=trueFlushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in… - POSTFlush data streams or indices
/:index/_flush?allow_no_indices=true&expand_wildcards=open&force=true&ignore_unavailable=false&wait_if_ongoing=trueFlushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in… - POSTForce a merge
/_forcemerge?allow_no_indices=true&expand_wildcards=open&flush=true&ignore_unavailable=true&max_num_segments=0.0&only_expunge_deletes=false&wait_for_completion=truePerform the force merge operation on the shards of one or more indices. For data streams, the API forces a merge on the shards of the stream's backing… - POSTForce a merge
/:index/_forcemerge?allow_no_indices=true&expand_wildcards=open&flush=true&ignore_unavailable=true&max_num_segments=0.0&only_expunge_deletes=false&wait_for_completion=truePerform the force merge operation on the shards of one or more indices. For data streams, the API forces a merge on the shards of the stream's backing… - GETGet aliases
/_alias?allow_no_indices=true&expand_wildcards=all&ignore_unavailable=false&master_timeout=30sRetrieves information for one or more data stream or index aliases. Required authorization * Index privileges: view_index_metadata - GETGet aliases
/:index/_alias?allow_no_indices=true&expand_wildcards=all&ignore_unavailable=false&master_timeout=30sRetrieves information for one or more data stream or index aliases. Required authorization * Index privileges: view_index_metadata - GETGet field mapping definitions
/_mapping/field/:fields?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&include_defaults=falseRetrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices. This API is useful… - GETGet field mapping definitions
/:index/_mapping/field/:fields?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&include_defaults=falseRetrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices. This API is useful… - GETGet index templates
/_index_template?local=false&flat_settings=false&master_timeout=30s&include_defaults=false&include_managed_fields=falseGet information about one or more index templates. Required authorization * Cluster privileges: manage_index_templates - GETGet mapping definitions
/_mapping?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&local=false&master_timeout=30sFor data streams, the API retrieves mappings for the stream’s backing indices. Required authorization * Index privileges: view_index_metadata - GETGet mapping definitions
/:index/_mapping?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&local=false&master_timeout=30sFor data streams, the API retrieves mappings for the stream’s backing indices. Required authorization * Index privileges: view_index_metadata - PUTUpdate field mappings
/:index/_mapping?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&master_timeout=30s&timeout=30s&write_index_only=falseAdd new fields to an existing data stream or index. You can use the update mapping API to: Add a new field to an existing index Update mappings for multiple… - POSTUpdate field mappings
/:index/_mapping?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&master_timeout=30s&timeout=30s&write_index_only=falseAdd new fields to an existing data stream or index. You can use the update mapping API to: Add a new field to an existing index Update mappings for multiple… - GETGet index settings
/_settings?allow_no_indices=true&expand_wildcards=open&flat_settings=false&ignore_unavailable=false&include_defaults=false&local=false&master_timeout=30sGet setting information for one or more indices. For data streams, it returns setting information for the stream's backing indices. Required authorization *… - PUTUpdate index settings
/_settings?allow_no_indices=false&expand_wildcards=open&flat_settings=false&ignore_unavailable=false&master_timeout=30s&preserve_existing=false&reopen=false&timeout=30sChanges dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default. To revert a setting to the… - GETGet index settings
/:index/_settings?allow_no_indices=true&expand_wildcards=open&flat_settings=false&ignore_unavailable=false&include_defaults=false&local=false&master_timeout=30sGet setting information for one or more indices. For data streams, it returns setting information for the stream's backing indices. Required authorization *… - PUTUpdate index settings
/:index/_settings?allow_no_indices=false&expand_wildcards=open&flat_settings=false&ignore_unavailable=false&master_timeout=30s&preserve_existing=false&reopen=false&timeout=30sChanges dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default. To revert a setting to the… - GETGet index settings
/:index/_settings/:name?allow_no_indices=true&expand_wildcards=open&flat_settings=false&ignore_unavailable=false&include_defaults=false&local=false&master_timeout=30sGet setting information for one or more indices. For data streams, it returns setting information for the stream's backing indices. Required authorization *… - GETGet index settings
/_settings/:name?allow_no_indices=true&expand_wildcards=open&flat_settings=false&ignore_unavailable=false&include_defaults=false&local=false&master_timeout=30sGet setting information for one or more indices. For data streams, it returns setting information for the stream's backing indices. Required authorization *… - GETGet legacy index templates
/_template?flat_settings=false&local=false&master_timeout=30sDeprecated. Get information about one or more index templates. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be… - POSTOpen a closed index
/:index/_open?allow_no_indices=true&expand_wildcards=closed&ignore_unavailable=false&master_timeout=30s&timeout=30s&wait_for_active_shards=1For data streams, the API opens any closed backing indices. A closed index is blocked for read/write operations and does not allow all operations that opened… - GETGet index recovery information
/_recovery?active_only=false&detailed=false&allow_no_indices=true&expand_wildcards=open&ignore_unavailable=falseGet information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream's backing… - GETGet index recovery information
/:index/_recovery?active_only=false&detailed=false&allow_no_indices=true&expand_wildcards=open&ignore_unavailable=falseGet information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream's backing… - GETRefresh an index
/_refresh?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=falseA refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s… - POSTRefresh an index
/_refresh?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=falseA refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s… - GETRefresh an index
/:index/_refresh?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=falseA refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s… - POSTRefresh an index
/:index/_refresh?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=falseA refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s… - GETReload search analyzers
/:index/_reload_search_analyzers?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=true&resource=stringReload an index's search analyzers and their resources. For data streams, the API reloads search analyzers and resources for the stream's backing indices.… - POSTReload search analyzers
/:index/_reload_search_analyzers?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=true&resource=stringReload an index's search analyzers and their resources. For data streams, the API reloads search analyzers and resources for the stream's backing indices.… - GETResolve the cluster
/_resolve/cluster?allow_no_indices=true&expand_wildcards=open&ignore_throttled=false&ignore_unavailable=false&timeout=stringResolve the specified index expressions to return information about each cluster, including the local "querying" cluster, if included. If no index expression… - GETResolve the cluster
/_resolve/cluster/:name?allow_no_indices=true&expand_wildcards=open&ignore_throttled=false&ignore_unavailable=false&timeout=stringResolve the specified index expressions to return information about each cluster, including the local "querying" cluster, if included. If no index expression… - GETResolve indices
/_resolve/index/:name?expand_wildcards=open&ignore_unavailable=false&allow_no_indices=true&mode=standardResolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported. Required authorization *… - POSTResolve indices
/_resolve/index/:name?expand_wildcards=open&ignore_unavailable=false&allow_no_indices=true&mode=standardResolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported. Required authorization *… - POSTRoll over to a new index
/:alias/_rollover?dry_run=false&master_timeout=30s&timeout=30s&wait_for_active_shards=1&lazy=falseTIP: To automate rollovers, use index lifecycle management (ILM) in deployments that support it. Serverless does not support ILM. For data streams in… - POSTRoll over to a new index
/:alias/_rollover/:new_index?dry_run=false&master_timeout=30s&timeout=30s&wait_for_active_shards=1&lazy=falseTIP: To automate rollovers, use index lifecycle management (ILM) in deployments that support it. Serverless does not support ILM. For data streams in… - GETGet index segments
/_segments?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&include_auto_calibration=false&vector_formats=falseGet low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream's backing indices.… - GETGet index segments
/:index/_segments?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&include_auto_calibration=false&vector_formats=falseGet low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream's backing indices.… - GETGet index shard stores
/_shard_stores?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&status=greenGet store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream's backing indices. The… - GETGet index shard stores
/:index/_shard_stores?allow_no_indices=true&expand_wildcards=open&ignore_unavailable=false&status=greenGet store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream's backing indices. The… - PUTShrink an index
/:index/_shrink/:target?master_timeout=30s&timeout=30s&wait_for_active_shards=1Shrink an index into a new index with fewer primary shards. Before you can shrink an index: * The index must be read-only. * A copy of every shard in the… - POSTShrink an index
/:index/_shrink/:target?master_timeout=30s&timeout=30s&wait_for_active_shards=1Shrink an index into a new index with fewer primary shards. Before you can shrink an index: * The index must be read-only. * A copy of every shard in the… - POSTSimulate an index
/_index_template/_simulate_index/:name?create=false&cause=false&master_timeout=30s&include_defaults=falseGet the index configuration that would be applied to the specified index from an existing index template. Required authorization * Cluster privileges:… - POSTSimulate an index template
/_index_template/_simulate?create=false&cause=false&master_timeout=30s&include_defaults=falseGet the index configuration that would be applied by a particular index template. Required authorization * Cluster privileges: manage_index_templates - POSTSimulate an index template
/_index_template/_simulate/:name?create=false&cause=false&master_timeout=30s&include_defaults=falseGet the index configuration that would be applied by a particular index template. Required authorization * Cluster privileges: manage_index_templates - PUTSplit an index
/:index/_split/:target?master_timeout=30s&timeout=30s&wait_for_active_shards=1Split an index into a new index with more primary shards. * Before you can split an index: * The index must be read-only. * The cluster health status must be… - POSTSplit an index
/:index/_split/:target?master_timeout=30s&timeout=30s&wait_for_active_shards=1Split an index into a new index with more primary shards. * Before you can split an index: * The index must be read-only. * The cluster health status must be… - GETGet index statistics
/_stats?completion_fields=string&expand_wildcards=open&fielddata_fields=string&fields=string&forbid_closed_indices=true&groups=string&include_auto_calibration=false&include_segment_file_sizes=false&include_unloaded_segments=false&level=indicesFor data streams, the API retrieves statistics for the stream's backing indices. By default, the returned statistics are index-level with primaries and total… - GETGet index statistics
/_stats/:metric?completion_fields=string&expand_wildcards=open&fielddata_fields=string&fields=string&forbid_closed_indices=true&groups=string&include_auto_calibration=false&include_segment_file_sizes=false&include_unloaded_segments=false&level=indicesFor data streams, the API retrieves statistics for the stream's backing indices. By default, the returned statistics are index-level with primaries and total… - GETGet index statistics
/:index/_stats?completion_fields=string&expand_wildcards=open&fielddata_fields=string&fields=string&forbid_closed_indices=true&groups=string&include_auto_calibration=false&include_segment_file_sizes=false&include_unloaded_segments=false&level=indicesFor data streams, the API retrieves statistics for the stream's backing indices. By default, the returned statistics are index-level with primaries and total… - GETGet index statistics
/:index/_stats/:metric?completion_fields=string&expand_wildcards=open&fielddata_fields=string&fields=string&forbid_closed_indices=true&groups=string&include_auto_calibration=false&include_segment_file_sizes=false&include_unloaded_segments=false&level=indicesFor data streams, the API retrieves statistics for the stream's backing indices. By default, the returned statistics are index-level with primaries and total… - POSTUpdate aliases and delete indices atomically
/_aliases?master_timeout=30s&timeout=30sApplies one or more actions in a single request: Add a data stream or index to an alias. Remove a data stream or index from an alias. Delete an index in that… - GETValidate a query
/_validate/query?allow_no_indices=true&all_shards=false&analyzer=string&analyze_wildcard=false&default_operator=or&df=string&expand_wildcards=open&explain=false&ignore_unavailable=false&lenient=false&rewrite=false&q=string&routing=stringValidates a query without running it. Required authorization * Index privileges: view_index_metadata,manage - POSTValidate a query
/_validate/query?allow_no_indices=true&all_shards=false&analyzer=string&analyze_wildcard=false&default_operator=or&df=string&expand_wildcards=open&explain=false&ignore_unavailable=false&lenient=false&rewrite=false&q=string&routing=stringValidates a query without running it. Required authorization * Index privileges: view_index_metadata,manage - GETValidate a query
/:index/_validate/query?allow_no_indices=true&all_shards=false&analyzer=string&analyze_wildcard=false&default_operator=or&df=string&expand_wildcards=open&explain=false&ignore_unavailable=false&lenient=false&rewrite=false&q=string&routing=stringValidates a query without running it. Required authorization * Index privileges: view_index_metadata,manage - POSTValidate a query
/:index/_validate/query?allow_no_indices=true&all_shards=false&analyzer=string&analyze_wildcard=false&default_operator=or&df=string&expand_wildcards=open&explain=false&ignore_unavailable=false&lenient=false&rewrite=false&q=string&routing=stringValidates a query without running it. Required authorization * Index privileges: view_index_metadata,manage
connector
- PUTCheck in a connector
/_connector/:connector_id/_check_inUpdate the last_seen field in the connector and set it to the current timestamp. - GETGet a connector
/_connector/:connector_id?include_deleted=falseGet the details about a connector. - PUTCreate or update a connector
/_connector/:connector_id - DELETEDelete a connector
/_connector/:connector_id?delete_sync_jobs=false&hard=falseRemoves a connector and associated sync jobs. This is a destructive action that is not recoverable. NOTE: This action doesn’t delete any API keys, ingest…
Showing 300 of 400 endpoints. Fork the collection to see all of them.
API details
- Authentication
- None declared in the description
- Operations
- 854 operations on 587 pathsGET 357POST 274PUT 141DELETE 73HEAD 9
24 marked deprecated - Main resources
- indices 104security 101ml anomaly 70search 57inference 51cat 47cluster 38document 33connector 30watcher 24
- Response formats
application/json- Description format
- OpenAPI 3.0.3
- Links
- OpenAPI document
- Listed from
- Elasticsearch's published OpenAPI description (elastic/elasticsearch-specification) (Apache-2.0)
How to test the Elasticsearch Request & Response Specification in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Elasticsearch Request & Response Specification collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Get async search results” (GET /_async_search/:id?keep_alive=string&typed_keys=true&wait_for_completion_timeout=string&return_intermediate_results=true), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Elasticsearch Request & Response Specification?
Elasticsearch Request & Response Specification endpoints from Elastic It is listed under Data & analytics and has 854 endpoints.
Who publishes the Elasticsearch Request & Response Specification?
It is listed from Elastic's public API description (an OpenAPI document), not published by Elastic on Swastik Codes. Anyone who controls elastic.co can claim the profile by adding a DNS TXT record.
How do I authenticate with the Elasticsearch Request & Response Specification?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Elasticsearch Request & Response Specification have?
854 operations on 587 paths (357 GET, 274 POST, 141 PUT, 73 DELETE, 9 HEAD). The largest groups are indices, security, ml anomaly, search. This listing's collection holds the first 400.
Is forking the Elasticsearch Request & Response Specification free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.