Complete Elasticsearch commands reference — 674 commands across 30 categories. Quick reference cheat sheet for Cross-platform.
This is the Elasticsearch REST API surface as an endpoint reference: method and path for every documented route, grouped the way the official API reference groups them. It is long because Elasticsearch is large; the notes below point at the few dozen routes an operator or developer actually types, and explain the conventions that make the rest of the table readable.
| Shortcut | Action |
|---|---|
| GET /_component_template/{name} | Get component templates |
| PUT /_component_template/{name} | Create or update a component template |
| POST /_component_template/{name} | Create or update a component template |
| DELETE /_component_template/{name} | Delete component templates |
| HEAD /_component_template/{name} | Check component templates |
| GET /_component_template | Get component templates |
| POST /_dangling/{index_uuid} | Import a dangling index |
| DELETE /_dangling/{index_uuid} | Delete a dangling index |
| GET /_dangling | Get the dangling indices |
| PUT /{index}/_block/{block} | Add an index block |
| DELETE /{index}/_block/{block} | Remove an index block |
| GET /_analyze | Get tokens from text analysis |
| POST /_analyze | Get tokens from text analysis |
| GET /{index}/_analyze | Get tokens from text analysis |
| POST /{index}/_analyze | Get tokens from text analysis |
| POST /_cache/clear | Clear the cache |
| POST /{index}/_cache/clear | Clear the cache |
| PUT /{index}/_clone/{target} | Clone an index |
| POST /{index}/_clone/{target} | Clone an index |
| POST /{index}/_close | Close an index |
| GET /{index} | Get index information |
| PUT /{index} | Create an index |
| DELETE /{index} | Delete indices |
| HEAD /{index} | Check indices |
| GET /{index}/_alias/{name} | Get aliases |
| PUT /{index}/_alias/{name} | Create or update an alias |
| POST /{index}/_alias/{name} | Create or update an alias |
| DELETE /{index}/_alias/{name} | Delete an alias |
| HEAD /{index}/_alias/{name} | Check aliases |
| PUT /{index}/_aliases/{name} | Create or update an alias |
| POST /{index}/_aliases/{name} | Create or update an alias |
| DELETE /{index}/_aliases/{name} | Delete an alias |
| DELETE /_data_stream/{name}/_lifecycle | Delete data stream lifecycles |
| GET /_index_template/{name} | Get index templates |
| PUT /_index_template/{name} | Create or update an index template |
| POST /_index_template/{name} | Create or update an index template |
| DELETE /_index_template/{name} | Delete an index template |
| HEAD /_index_template/{name} | Check index templates |
| HEAD /_template/{name} | Check existence of index templates |
| POST /{index}/_disk_usage | Analyze the index disk usage |
| GET /_alias/{name} | Get aliases |
| HEAD /_alias/{name} | Check aliases |
| GET /{index}/_field_usage_stats | Get field usage stats |
| GET /_flush | Flush data streams or indices |
| POST /_flush | Flush data streams or indices |
| GET /{index}/_flush | Flush data streams or indices |
| POST /{index}/_flush | Flush data streams or indices |
| POST /_forcemerge | Force a merge |
| POST /{index}/_forcemerge | Force a merge |
| GET /_alias | Get aliases |
| GET /{index}/_alias | Get aliases |
| GET /_mapping/field/{fields} | Get mapping definitions |
| GET /{index}/_mapping/field/{fields} | Get mapping definitions |
| GET /_index_template | Get index templates |
| GET /_mapping | Get mapping definitions |
| GET /{index}/_mapping | Get mapping definitions |
| PUT /{index}/_mapping | Update field mappings |
| POST /{index}/_mapping | Update field mappings |
| GET /_settings | Get index settings |
| PUT /_settings | Update index settings |
| GET /{index}/_settings | Get index settings |
| PUT /{index}/_settings | Update index settings |
| GET /{index}/_settings/{name} | Get index settings |
| GET /_settings/{name} | Get index settings |
| POST /{index}/_open | Open a closed index |
| GET /_recovery | Get index recovery information |
| GET /{index}/_recovery | Get index recovery information |
| GET /_refresh | Refresh an index |
| POST /_refresh | Refresh an index |
| GET /{index}/_refresh | Refresh an index |
| POST /{index}/_refresh | Refresh an index |
| GET /{index}/_reload_search_analyzers | Reload search analyzers |
| POST /{index}/_reload_search_analyzers | Reload search analyzers |
| GET /_resolve/cluster | Resolve the cluster |
| GET /_resolve/cluster/{name} | Resolve the cluster |
| GET /_resolve/index/{name} | Resolve indices |
| POST /_resolve/index/{name} | Resolve indices |
| POST /{alias}/_rollover | Roll over to a new index |
| POST /{alias}/_rollover/{new_index} | Roll over to a new index |
| GET /_segments | Get index segments |
| GET /{index}/_segments | Get index segments |
| GET /_shard_stores | Get index shard stores |
| GET /{index}/_shard_stores | Get index shard stores |
| PUT /{index}/_shrink/{target} | Shrink an index |
| POST /{index}/_shrink/{target} | Shrink an index |
| POST /_index_template/_simulate_index/{name} | Simulate an index |
| POST /_index_template/_simulate | Simulate an index template |
| POST /_index_template/_simulate/{name} | Simulate an index template |
| PUT /{index}/_split/{target} | Split an index |
| POST /{index}/_split/{target} | Split an index |
| GET /_stats | Get index statistics |
| GET /_stats/{metric} | Get index statistics |
| GET /{index}/_stats | Get index statistics |
| GET /{index}/_stats/{metric} | Get index statistics |
| POST /_aliases | Create or update an alias |
| GET /_validate/query | Validate a query |
| POST /_validate/query | Validate a query |
| GET /{index}/_validate/query | Validate a query |
| POST /{index}/_validate/query | Validate a query |
| Shortcut | Action |
|---|---|
| POST /_security/profile/_activate | Activate a user profile |
| GET /_security/_authenticate | Authenticate a user |
| GET /_security/role | Get roles |
| POST /_security/role | Bulk create or update roles |
| DELETE /_security/role | Bulk delete roles |
| POST /_security/api_key/_bulk_update | Bulk update API keys |
| PUT /_security/user/{username}/_password | Change passwords |
| POST /_security/user/{username}/_password | Change passwords |
| PUT /_security/user/_password | Change passwords |
| POST /_security/user/_password | Change passwords |
| POST /_security/api_key/{ids}/_clear_cache | Clear the API key cache |
| POST /_security/privilege/{application}/_clear_cache | Clear the privileges cache |
| POST /_security/realm/{realms}/_clear_cache | Clear the user cache |
| POST /_security/role/{name}/_clear_cache | Clear the roles cache |
| POST /_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache | Clear service account token caches |
| PUT /_security/api_key/clone | Clone an API key |
| POST /_security/api_key/clone | Clone an API key |
| GET /_security/api_key | Get API key information |
| PUT /_security/api_key | Create an API key |
| POST /_security/api_key | Create an API key |
| DELETE /_security/api_key | Invalidate API keys |
| POST /_security/cross_cluster/api_key | Create a cross-cluster API key |
| PUT /_security/service/{namespace}/{service}/credential/token/{name} | Create a service account token |
| POST /_security/service/{namespace}/{service}/credential/token/{name} | Create a service account token |
| DELETE /_security/service/{namespace}/{service}/credential/token/{name} | Delete service account tokens |
| POST /_security/service/{namespace}/{service}/credential/token | Create a service account token |
| POST /_security/delegate_pki | Delegate PKI authentication |
| GET /_security/privilege/{application}/{name} | Get application privileges |
| DELETE /_security/privilege/{application}/{name} | Delete application privileges |
| GET /_security/role/{name} | Get roles |
| PUT /_security/role/{name} | Create or update roles |
| POST /_security/role/{name} | Create or update roles |
| DELETE /_security/role/{name} | Delete roles |
| GET /_security/role_mapping/{name} | Get role mappings |
| PUT /_security/role_mapping/{name} | Create or update role mappings |
| POST /_security/role_mapping/{name} | Create or update role mappings |
| DELETE /_security/role_mapping/{name} | Delete role mappings |
| GET /_security/user/{username} | Get users |
| PUT /_security/user/{username} | Create or update users |
| POST /_security/user/{username} | Create or update users |
| DELETE /_security/user/{username} | Delete users |
| PUT /_security/user/{username}/_disable | Disable users |
| POST /_security/user/{username}/_disable | Disable users |
| PUT /_security/profile/{uid}/_disable | Disable a user profile |
| POST /_security/profile/{uid}/_disable | Disable a user profile |
| PUT /_security/user/{username}/_enable | Enable users |
| POST /_security/user/{username}/_enable | Enable users |
| PUT /_security/profile/{uid}/_enable | Enable a user profile |
| POST /_security/profile/{uid}/_enable | Enable a user profile |
| GET /_security/enroll/kibana | Enroll Kibana |
| GET /_security/enroll/node | Enroll a node |
| GET /_security/privilege/_builtin | Get builtin privileges |
| GET /_security/privilege | Get application privileges |
| PUT /_security/privilege | Create or update application privileges |
| POST /_security/privilege | Create or update application privileges |
| GET /_security/privilege/{application} | Get application privileges |
| GET /_security/role_mapping | Get role mappings |
| GET /_security/service/{namespace}/{service} | Get service accounts |
| GET /_security/service/{namespace} | Get service accounts |
| GET /_security/service | Get service accounts |
| GET /_security/service/{namespace}/{service}/credential | Get service account credentials |
| GET /_security/settings | Get security index settings |
| PUT /_security/settings | Update security index settings |
| GET /_security/stats | Get security stats |
| POST /_security/oauth2/token | Get a token |
| DELETE /_security/oauth2/token | Invalidate a token |
| GET /_security/user | Get users |
| GET /_security/user/_privileges | Get user privileges |
| GET /_security/profile/{uid} | Get a user profile |
| POST /_security/api_key/grant | Grant an API key |
| GET /_security/user/_has_privileges | Check user privileges |
| POST /_security/user/_has_privileges | Check user privileges |
| GET /_security/user/{user}/_has_privileges | Check user privileges |
| POST /_security/user/{user}/_has_privileges | Check user privileges |
| GET /_security/profile/_has_privileges | Check user profile privileges |
| POST /_security/profile/_has_privileges | Check user profile privileges |
| POST /_security/oidc/authenticate | Authenticate OpenID Connect |
| POST /_security/oidc/logout | Logout of OpenID Connect |
| POST /_security/oidc/prepare | Prepare OpenID connect authentication |
| GET /_security/_query/api_key | Find API keys with a query |
| POST /_security/_query/api_key | Find API keys with a query |
| GET /_security/_query/role | Find roles with a query |
| POST /_security/_query/role | Find roles with a query |
| GET /_security/_query/user | Find users with a query |
| POST /_security/_query/user | Find users with a query |
| POST /_security/saml/authenticate | Authenticate SAML |
| POST /_security/saml/complete_logout | Logout of SAML completely |
| POST /_security/saml/invalidate | Invalidate SAML |
| POST /_security/saml/logout | Logout of SAML |
| POST /_security/saml/prepare | Prepare SAML authentication |
| GET /_security/saml/metadata/{realm_name} | Create SAML service provider metadata |
| GET /_security/profile/_suggest | Suggest a user profile |
| POST /_security/profile/_suggest | Suggest a user profile |
| PUT /_security/api_key/{id} | Update an API key |
| PUT /_security/cross_cluster/api_key/{id} | Update a cross-cluster API key |
| PUT /_security/profile/{uid}/_data | Update user profile data |
| POST /_security/profile/{uid}/_data | Update user profile data |
| GET /_ssl/certificates | Get SSL certificates |
| Shortcut | Action |
|---|---|
| GET /_async_search/{id} | Get async search results |
| DELETE /_async_search/{id} | Delete an async search |
| GET /_async_search/status/{id} | Get the async search status |
| POST /_async_search | Run an async search |
| POST /{index}/_async_search | Run an async search |
| GET /_search/scroll | Run a scrolling search |
| POST /_search/scroll | Run a scrolling search |
| DELETE /_search/scroll | Clear a scrolling search |
| GET /_search/scroll/{scroll_id} | Run a scrolling search |
| POST /_search/scroll/{scroll_id} | Run a scrolling search |
| DELETE /_search/scroll/{scroll_id} | Clear a scrolling search |
| DELETE /_pit | Close a point in time |
| GET /_count | Count search results |
| POST /_count | Count search results |
| GET /{index}/_count | Count search results |
| POST /{index}/_count | Count search results |
| GET /{index}/_explain/{id} | Explain a document match result |
| POST /{index}/_explain/{id} | Explain a document match result |
| GET /_field_caps | Get the field capabilities |
| POST /_field_caps | Get the field capabilities |
| GET /{index}/_field_caps | Get the field capabilities |
| POST /{index}/_field_caps | Get the field capabilities |
| GET /_msearch | Run multiple searches |
| POST /_msearch | Run multiple searches |
| GET /{index}/_msearch | Run multiple searches |
| POST /{index}/_msearch | Run multiple searches |
| GET /_msearch/template | Run multiple templated searches |
| POST /_msearch/template | Run multiple templated searches |
| GET /{index}/_msearch/template | Run multiple templated searches |
| POST /{index}/_msearch/template | Run multiple templated searches |
| POST /{index}/_pit | Open a point in time |
| GET /_rank_eval | Evaluate ranked search results |
| POST /_rank_eval | Evaluate ranked search results |
| GET /{index}/_rank_eval | Evaluate ranked search results |
| POST /{index}/_rank_eval | Evaluate ranked search results |
| GET /_render/template | Render a search template |
| POST /_render/template | Render a search template |
| GET /_render/template/{id} | Render a search template |
| POST /_render/template/{id} | Render a search template |
| GET /_search | Run a search |
| POST /_search | Run a search |
| GET /{index}/_search | Run a search |
| POST /{index}/_search | Run a search |
| GET /{index}/_mvt/{field}/{zoom}/{x}/{y} | Search a vector tile |
| POST /{index}/_mvt/{field}/{zoom}/{x}/{y} | Search a vector tile |
| GET /_search_shards | Get the search shards |
| POST /_search_shards | Get the search shards |
| GET /{index}/_search_shards | Get the search shards |
| POST /{index}/_search_shards | Get the search shards |
| GET /_search/template | Run a search with a search template |
| POST /_search/template | Run a search with a search template |
| GET /{index}/_search/template | Run a search with a search template |
| POST /{index}/_search/template | Run a search with a search template |
| GET /{index}/_terms_enum | Get terms in an index |
| POST /{index}/_terms_enum | Get terms in an index |
| Shortcut | Action |
|---|---|
| GET /_cat/aliases | Get aliases |
| GET /_cat/aliases/{name} | Get aliases |
| GET /_cat/allocation | Get shard allocation information |
| GET /_cat/allocation/{node_id} | Get shard allocation information |
| GET /_cat/circuit_breaker | Get circuit breakers statistics |
| GET /_cat/circuit_breaker/{circuit_breaker_patterns} | Get circuit breakers statistics |
| GET /_cat/component_templates | Get component templates |
| GET /_cat/component_templates/{name} | Get component templates |
| GET /_cat/count | Get a document count |
| POST /_cat/count | Get a document count |
| GET /_cat/count/{index} | Get a document count |
| POST /_cat/count/{index} | Get a document count |
| GET /_cat/fielddata | Get field data cache information |
| GET /_cat/fielddata/{fields} | Get field data cache information |
| GET /_cat/health | Get the cluster health status |
| GET /_cat | Get CAT help |
| GET /_cat/indices | Get index information |
| GET /_cat/indices/{index} | Get index information |
| GET /_cat/master | Get master node information |
| GET /_cat/ml/data_frame/analytics | Get data frame analytics jobs |
| GET /_cat/ml/data_frame/analytics/{id} | Get data frame analytics jobs |
| GET /_cat/ml/datafeeds | Get datafeeds |
| GET /_cat/ml/datafeeds/{datafeed_id} | Get datafeeds |
| GET /_cat/ml/anomaly_detectors | Get anomaly detection jobs |
| GET /_cat/ml/anomaly_detectors/{job_id} | Get anomaly detection jobs |
| GET /_cat/ml/trained_models | Get trained models |
| GET /_cat/ml/trained_models/{model_id} | Get trained models |
| GET /_cat/nodeattrs | Get node attribute information |
| GET /_cat/nodes | Get node information |
| GET /_cat/pending_tasks | Get pending task information |
| GET /_cat/plugins | Get plugin information |
| GET /_cat/recovery | Get shard recovery information |
| GET /_cat/recovery/{index} | Get shard recovery information |
| GET /_cat/repositories | Get snapshot repository information |
| GET /_cat/segments | Get segment information |
| GET /_cat/segments/{index} | Get segment information |
| GET /_cat/shards | Get shard information |
| GET /_cat/shards/{index} | Get shard information |
| GET /_cat/snapshots | Get snapshot information |
| GET /_cat/snapshots/{repository} | Get snapshot information |
| GET /_cat/tasks | Get task information |
| GET /_cat/templates | Get index template information |
| GET /_cat/templates/{name} | Get index template information |
| GET /_cat/thread_pool | Get thread pool statistics |
| GET /_cat/thread_pool/{thread_pool_patterns} | Get thread pool statistics |
| GET /_cat/transforms | Get transform information |
| GET /_cat/transforms/{transform_id} | Get transform information |
| Shortcut | Action |
|---|---|
| POST /_inference/chat_completion/{inference_id}/_stream | Perform chat completion inference on the service |
| POST /_inference/completion/{inference_id} | Perform completion inference on the service |
| GET /_inference/{inference_id} | Get an inference endpoint |
| PUT /_inference/{inference_id} | Create an inference endpoint |
| POST /_inference/{inference_id} | Perform inference on the service |
| DELETE /_inference/{inference_id} | Delete an inference endpoint |
| GET /_inference/{task_type}/{inference_id} | Get an inference endpoint |
| PUT /_inference/{task_type}/{inference_id} | Create an inference endpoint |
| POST /_inference/{task_type}/{inference_id} | Perform inference on the service |
| DELETE /_inference/{task_type}/{inference_id} | Delete an inference endpoint |
| GET /_inference/_region_policy | Get the inference region policy |
| PUT /_inference/_region_policy | Create or update the inference region policy |
| DELETE /_inference/_region_policy | Delete the inference region policy |
| POST /_inference/embedding/{inference_id} | Perform dense embedding inference on the service |
| GET /_inference | Get an inference endpoint |
| GET /_inference/{task_type}/_all | Get an inference endpoint |
| PUT /_inference/{task_type}/{ai21_inference_id} | Create a AI21 inference endpoint |
| PUT /_inference/{task_type}/{alibabacloud_inference_id} | Create an AlibabaCloud AI Search inference endpoint |
| PUT /_inference/{task_type}/{amazonbedrock_inference_id} | Create an Amazon Bedrock inference endpoint |
| PUT /_inference/{task_type}/{amazonsagemaker_inference_id} | Create an Amazon SageMaker inference endpoint |
| PUT /_inference/{task_type}/{anthropic_inference_id} | Create an Anthropic inference endpoint |
| PUT /_inference/{task_type}/{azureaistudio_inference_id} | Create an Azure AI studio inference endpoint |
| PUT /_inference/{task_type}/{azureopenai_inference_id} | Create an Azure OpenAI inference endpoint |
| PUT /_inference/{task_type}/{cohere_inference_id} | Create a Cohere inference endpoint |
| PUT /_inference/{task_type}/{contextualai_inference_id} | Create an Contextual AI inference endpoint |
| PUT /_inference/{task_type}/{custom_inference_id} | Create a custom inference endpoint |
| PUT /_inference/{task_type}/{deepseek_inference_id} | Create a DeepSeek inference endpoint |
| PUT /_inference/{task_type}/{elasticsearch_inference_id} | Create an Elasticsearch inference endpoint |
| PUT /_inference/{task_type}/{fireworksai_inference_id} | Create a Fireworks AI inference endpoint |
| PUT /_inference/{task_type}/{googleaistudio_inference_id} | Create an Google AI Studio inference endpoint |
| PUT /_inference/{task_type}/{googlevertexai_inference_id} | Create a Google Vertex AI inference endpoint |
| PUT /_inference/{task_type}/{groq_inference_id} | Create a Groq inference endpoint |
| PUT /_inference/{task_type}/{huggingface_inference_id} | Create a Hugging Face inference endpoint |
| PUT /_inference/{task_type}/{jinaai_inference_id} | Create an JinaAI inference endpoint |
| PUT /_inference/{task_type}/{llama_inference_id} | Create a Llama inference endpoint |
| PUT /_inference/{task_type}/{mistral_inference_id} | Create a Mistral inference endpoint |
| PUT /_inference/{task_type}/{nvidia_inference_id} | Create an Nvidia inference endpoint |
| PUT /_inference/{task_type}/{openai_inference_id} | Create an OpenAI inference endpoint |
| PUT /_inference/{task_type}/{openshiftai_inference_id} | Create an OpenShift AI inference endpoint |
| PUT /_inference/{task_type}/{voyageai_inference_id} | Create a VoyageAI inference endpoint |
| PUT /_inference/{task_type}/{watsonx_inference_id} | Create a Watsonx inference endpoint |
| POST /_inference/rerank/{inference_id} | Perform reranking inference on the service |
| POST /_inference/sparse_embedding/{inference_id} | Perform sparse embedding inference on the service |
| POST /_inference/completion/{inference_id}/_stream | Perform streaming completion inference on the service |
| POST /_inference/text_embedding/{inference_id} | Perform text embedding inference on the service |
| PUT /_inference/{inference_id}/_update | Update an inference endpoint |
| PUT /_inference/{task_type}/{inference_id}/_update | Update an inference endpoint |
| Shortcut | Action |
|---|---|
| GET /_cluster/allocation/explain | Explain the shard allocations |
| POST /_cluster/allocation/explain | Explain the shard allocations |
| POST /_cluster/voting_config_exclusions | Update voting configuration exclusions |
| DELETE /_cluster/voting_config_exclusions | Clear cluster voting config exclusions |
| GET /_cluster/settings | Get cluster-wide settings |
| PUT /_cluster/settings | Update the cluster settings |
| GET /_cluster/health | Get the cluster health status |
| GET /_cluster/health/{index} | Get the cluster health status |
| GET /_info/{target} | Get cluster info |
| GET /_cluster/pending_tasks | Get the pending cluster tasks |
| GET /_remote/info | Get remote cluster information |
| POST /_cluster/reroute | Reroute the cluster |
| GET /_cluster/state | Get the cluster state |
| GET /_cluster/state/{metric} | Get the cluster state |
| GET /_cluster/state/{metric}/{index} | Get the cluster state |
| GET /_cluster/stats | Get cluster statistics |
| GET /_cluster/stats/nodes/{node_id} | Get cluster statistics |
| HEAD / | Ping the cluster |
| DELETE /_nodes/{node_id}/_repositories_metering/{max_archive_version} | Clear the archived repositories metering |
| GET /_nodes/{node_id}/_repositories_metering | Get cluster repositories metering |
| GET /_nodes/hot_threads | Get the hot threads for nodes |
| GET /_nodes/{node_id}/hot_threads | Get the hot threads for nodes |
| GET /_nodes | Get node information |
| GET /_nodes/{node_id} | Get node information |
| GET /_nodes/{metric} | Get node information |
| GET /_nodes/{node_id}/{metric} | Get node information |
| POST /_nodes/reload_secure_settings | Reload the keystore on nodes in the cluster |
| POST /_nodes/{node_id}/reload_secure_settings | Reload the keystore on nodes in the cluster |
| GET /_nodes/stats | Get node statistics |
| GET /_nodes/{node_id}/stats | Get node statistics |
| GET /_nodes/stats/{metric} | Get node statistics |
| GET /_nodes/{node_id}/stats/{metric} | Get node statistics |
| GET /_nodes/stats/{metric}/{index_metric} | Get node statistics |
| GET /_nodes/{node_id}/stats/{metric}/{index_metric} | Get node statistics |
| GET /_nodes/usage | Get feature usage information |
| GET /_nodes/{node_id}/usage | Get feature usage information |
| GET /_nodes/usage/{metric} | Get feature usage information |
| GET /_nodes/{node_id}/usage/{metric} | Get feature usage information |
| Shortcut | Action |
|---|---|
| PUT /_bulk | Bulk index or delete documents |
| POST /_bulk | Bulk index or delete documents |
| PUT /{index}/_bulk | Bulk index or delete documents |
| POST /{index}/_bulk | Bulk index or delete documents |
| PUT /{index}/_create/{id} | Create a new document in the index |
| POST /{index}/_create/{id} | Create a new document in the index |
| GET /{index}/_doc/{id} | Get a document by its ID |
| PUT /{index}/_doc/{id} | Create or update a document in an index |
| POST /{index}/_doc/{id} | Create or update a document in an index |
| DELETE /{index}/_doc/{id} | Delete a document |
| HEAD /{index}/_doc/{id} | Check a document |
| POST /{index}/_delete_by_query | Delete documents |
| POST /_delete_by_query/{task_id}/_rethrottle | Throttle a delete by query operation |
| GET /{index}/_source/{id} | Get a document's source |
| HEAD /{index}/_source/{id} | Check for a document source |
| POST /{index}/_doc | Create or update a document in an index |
| POST /_reindex | Reindex documents |
| GET /_mget | Get multiple documents |
| POST /_mget | Get multiple documents |
| GET /{index}/_mget | Get multiple documents |
| POST /{index}/_mget | Get multiple documents |
| GET /_mtermvectors | Get multiple term vectors |
| POST /_mtermvectors | Get multiple term vectors |
| GET /{index}/_mtermvectors | Get multiple term vectors |
| POST /{index}/_mtermvectors | Get multiple term vectors |
| POST /_reindex/{task_id}/_rethrottle | Throttle a reindex operation |
| GET /{index}/_termvectors/{id} | Get term vector information |
| POST /{index}/_termvectors/{id} | Get term vector information |
| GET /{index}/_termvectors | Get term vector information |
| POST /{index}/_termvectors | Get term vector information |
| POST /{index}/_update/{id} | Update a document |
| POST /{index}/_update_by_query | Update documents |
| POST /_update_by_query/{task_id}/_rethrottle | Throttle an update by query operation |
| Shortcut | Action |
|---|---|
| PUT /_connector/{connector_id}/_check_in | Check in a connector |
| GET /_connector/{connector_id} | Get a connector |
| PUT /_connector/{connector_id} | Create or update a connector |
| DELETE /_connector/{connector_id} | Delete a connector |
| GET /_connector | Get all connectors |
| PUT /_connector | Create or update a connector |
| POST /_connector | Create a connector |
| PUT /_connector/_sync_job/{connector_sync_job_id}/_cancel | Cancel a connector sync job |
| PUT /_connector/_sync_job/{connector_sync_job_id}/_check_in | Check in a connector sync job |
| PUT /_connector/_sync_job/{connector_sync_job_id}/_claim | Claim a connector sync job |
| GET /_connector/_sync_job/{connector_sync_job_id} | Get a connector sync job |
| DELETE /_connector/_sync_job/{connector_sync_job_id} | Delete a connector sync job |
| PUT /_connector/_sync_job/{connector_sync_job_id}/_error | Set a connector sync job error |
| GET /_connector/_sync_job | Get all connector sync jobs |
| POST /_connector/_sync_job | Create a connector sync job |
| PUT /_connector/_sync_job/{connector_sync_job_id}/_stats | Set the connector sync job stats |
| PUT /_connector/{connector_id}/_filtering/_activate | Activate the connector draft filter |
| PUT /_connector/{connector_id}/_api_key_id | Update the connector API key ID |
| PUT /_connector/{connector_id}/_configuration | Update the connector configuration |
| PUT /_connector/{connector_id}/_error | Update the connector error field |
| PUT /_connector/{connector_id}/_features | Update the connector features |
| PUT /_connector/{connector_id}/_filtering | Update the connector filtering |
| PUT /_connector/{connector_id}/_filtering/_validation | Update the connector draft filtering validation |
| PUT /_connector/{connector_id}/_index_name | Update the connector index name |
| PUT /_connector/{connector_id}/_name | Update the connector name and description |
| PUT /_connector/{connector_id}/_native | Update the connector is_native flag |
| PUT /_connector/{connector_id}/_pipeline | Update the connector pipeline |
| PUT /_connector/{connector_id}/_scheduling | Update the connector scheduling |
| PUT /_connector/{connector_id}/_service_type | Update the connector service type |
| PUT /_connector/{connector_id}/_status | Update the connector status |
| Shortcut | Action |
|---|---|
| PUT /_watcher/watch/{watch_id}/_ack | Acknowledge a watch |
| POST /_watcher/watch/{watch_id}/_ack | Acknowledge a watch |
| PUT /_watcher/watch/{watch_id}/_ack/{action_id} | Acknowledge a watch |
| POST /_watcher/watch/{watch_id}/_ack/{action_id} | Acknowledge a watch |
| PUT /_watcher/watch/{watch_id}/_activate | Activate a watch |
| POST /_watcher/watch/{watch_id}/_activate | Activate a watch |
| PUT /_watcher/watch/{watch_id}/_deactivate | Deactivate a watch |
| POST /_watcher/watch/{watch_id}/_deactivate | Deactivate a watch |
| GET /_watcher/watch/{id} | Get a watch |
| PUT /_watcher/watch/{id} | Create or update a watch |
| POST /_watcher/watch/{id} | Create or update a watch |
| DELETE /_watcher/watch/{id} | Delete a watch |
| PUT /_watcher/watch/{id}/_execute | Run a watch |
| POST /_watcher/watch/{id}/_execute | Run a watch |
| PUT /_watcher/watch/_execute | Run a watch |
| POST /_watcher/watch/_execute | Run a watch |
| GET /_watcher/settings | Get Watcher index settings |
| PUT /_watcher/settings | Update Watcher index settings |
| GET /_watcher/_query/watches | Query watches |
| POST /_watcher/_query/watches | Query watches |
| POST /_watcher/_start | Start the watch service |
| GET /_watcher/stats | Get Watcher statistics |
| GET /_watcher/stats/{metric} | Get Watcher statistics |
| POST /_watcher/_stop | Stop the watch service |
| Shortcut | Action |
|---|---|
| GET /_ingest/geoip/database/{id} | Get GeoIP database configurations |
| PUT /_ingest/geoip/database/{id} | Create or update a GeoIP database configuration |
| DELETE /_ingest/geoip/database/{id} | Delete GeoIP database configurations |
| GET /_ingest/ip_location/database/{id} | Get IP geolocation database configurations |
| PUT /_ingest/ip_location/database/{id} | Create or update an IP geolocation database configuration |
| DELETE /_ingest/ip_location/database/{id} | Delete IP geolocation database configurations |
| GET /_ingest/pipeline/{id} | Get pipelines |
| PUT /_ingest/pipeline/{id} | Create or update a pipeline |
| DELETE /_ingest/pipeline/{id} | Delete pipelines |
| GET /_ingest/geoip/stats | Get GeoIP statistics |
| GET /_ingest/geoip/database | Get GeoIP database configurations |
| GET /_ingest/ip_location/database | Get IP geolocation database configurations |
| GET /_ingest/pipeline | Get pipelines |
| GET /_ingest/processor/grok | Run a grok processor |
| GET /_ingest/pipeline/_simulate | Simulate a pipeline |
| POST /_ingest/pipeline/_simulate | Simulate a pipeline |
| GET /_ingest/pipeline/{id}/_simulate | Simulate a pipeline |
| POST /_ingest/pipeline/{id}/_simulate | Simulate a pipeline |
| GET /_ingest/_simulate | Simulate data ingestion |
| POST /_ingest/_simulate | Simulate data ingestion |
| GET /_ingest/{index}/_simulate | Simulate data ingestion |
| POST /_ingest/{index}/_simulate | Simulate data ingestion |
| Shortcut | Action |
|---|---|
| GET /_data_stream/{name} | Get data streams |
| PUT /_data_stream/{name} | Create a data stream |
| DELETE /_data_stream/{name} | Delete data streams |
| GET /_data_stream/_stats | Get data stream stats |
| GET /_data_stream/{name}/_stats | Get data stream stats |
| GET /_data_stream/{name}/_lifecycle | Get data stream lifecycles |
| PUT /_data_stream/{name}/_lifecycle | Update data stream lifecycles |
| GET /_data_stream/{name}/_options | Get data stream options |
| PUT /_data_stream/{name}/_options | Update data stream options |
| DELETE /_data_stream/{name}/_options | Delete data stream options |
| POST /{index}/_downsample/{target_index} | Downsample an index |
| GET /{index}/_lifecycle/explain | Get the status for a data stream lifecycle |
| GET /_lifecycle/stats | Get data stream lifecycle stats |
| GET /_data_stream | Get data streams |
| GET /_data_stream/{name}/_mappings | Get data stream mappings |
| PUT /_data_stream/{name}/_mappings | Update data stream mappings |
| GET /_data_stream/{name}/_settings | Get data stream settings |
| PUT /_data_stream/{name}/_settings | Update data stream settings |
| POST /_data_stream/_migrate/{name} | Convert an index alias to a data stream |
| POST /_data_stream/_modify | Update data streams |
| POST /_data_stream/_promote/{name} | Promote a data stream |
| Shortcut | Action |
|---|---|
| POST /_query/async | Run an async ES|QL query |
| GET /_query/async/{id} | Get async ES|QL query results |
| DELETE /_query/async/{id} | Delete an async ES|QL query |
| POST /_query/async/{id}/stop | Stop async ES|QL query |
| GET /_query/data_source/{name} | Get one or more ES|QL data sources |
| PUT /_query/data_source/{name} | Create or update an ES|QL data source |
| DELETE /_query/data_source/{name} | Delete one or more ES|QL data sources |
| GET /_query/dataset/{name} | Get one or more ES|QL datasets |
| PUT /_query/dataset/{name} | Create or replace an ES|QL dataset |
| DELETE /_query/dataset/{name} | Delete one or more ES|QL datasets |
| GET /_query/view/{name} | Get an ES|QL view |
| PUT /_query/view/{name} | Create or update an ES|QL view |
| DELETE /_query/view/{name} | Delete an ES|QL view |
| GET /_query/data_source | Get one or more ES|QL data sources |
| GET /_query/dataset | Get one or more ES|QL datasets |
| GET /_query/queries/{id} | Get a specific running ES|QL query information |
| GET /_query/view | Get an ES|QL view |
| GET /_query/queries | Get running ES|QL queries information |
| POST /_query | Run an ES|QL query |
| Shortcut | Action |
|---|---|
| POST /_snapshot/{repository}/_cleanup | Clean up the snapshot repository |
| PUT /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot} | Clone a snapshot |
| GET /_snapshot/{repository}/{snapshot} | Get snapshot information |
| PUT /_snapshot/{repository}/{snapshot} | Create a snapshot |
| POST /_snapshot/{repository}/{snapshot} | Create a snapshot |
| DELETE /_snapshot/{repository}/{snapshot} | Delete snapshots |
| GET /_snapshot/{repository} | Get snapshot repository information |
| PUT /_snapshot/{repository} | Create or update a snapshot repository |
| POST /_snapshot/{repository} | Create or update a snapshot repository |
| DELETE /_snapshot/{repository} | Delete snapshot repositories |
| GET /_snapshot | Get snapshot repository information |
| POST /_snapshot/{repository}/_analyze | Analyze a snapshot repository |
| POST /_snapshot/{repository}/_verify_integrity | Verify the repository integrity |
| POST /_snapshot/{repository}/{snapshot}/_restore | Restore a snapshot |
| GET /_snapshot/_status | Get the snapshot status |
| GET /_snapshot/{repository}/_status | Get the snapshot status |
| GET /_snapshot/{repository}/{snapshot}/_status | Get the snapshot status |
| POST /_snapshot/{repository}/_verify | Verify a snapshot repository |
| Shortcut | Action |
|---|---|
| GET /_transform/{transform_id} | Get transforms |
| PUT /_transform/{transform_id} | Create a transform |
| DELETE /_transform/{transform_id} | Delete a transform |
| GET /_transform/_node_stats | Get node stats |
| GET /_transform | Get transforms |
| GET /_transform/{transform_id}/_stats | Get transform stats |
| GET /_transform/{transform_id}/_preview | Preview a transform |
| POST /_transform/{transform_id}/_preview | Preview a transform |
| GET /_transform/_preview | Preview a transform |
| POST /_transform/_preview | Preview a transform |
| POST /_transform/{transform_id}/_reset | Reset a transform |
| POST /_transform/{transform_id}/_schedule_now | Schedule a transform to start now |
| POST /_transform/set_upgrade_mode | Set upgrade_mode for transform indices |
| POST /_transform/{transform_id}/_start | Start a transform |
| POST /_transform/{transform_id}/_stop | Stop transforms |
| POST /_transform/{transform_id}/_update | Update a transform |
| POST /_transform/_upgrade | Upgrade all transforms |
| Shortcut | Action |
|---|---|
| GET /_ccr/auto_follow/{name} | Get auto-follow patterns |
| PUT /_ccr/auto_follow/{name} | Create or update auto-follow patterns |
| DELETE /_ccr/auto_follow/{name} | Delete auto-follow patterns |
| PUT /{index}/_ccr/follow | Create a follower |
| GET /{index}/_ccr/info | Get follower information |
| GET /{index}/_ccr/stats | Get follower stats |
| POST /{index}/_ccr/forget_follower | Forget a follower |
| GET /_ccr/auto_follow | Get auto-follow patterns |
| POST /_ccr/auto_follow/{name}/pause | Pause an auto-follow pattern |
| POST /{index}/_ccr/pause_follow | Pause a follower |
| POST /_ccr/auto_follow/{name}/resume | Resume an auto-follow pattern |
| POST /{index}/_ccr/resume_follow | Resume a follower |
| GET /_ccr/stats | Get cross-cluster replication stats |
| POST /{index}/_ccr/unfollow | Unfollow an index |
| Shortcut | Action |
|---|---|
| GET /_ilm/policy/{policy} | Get lifecycle policies |
| PUT /_ilm/policy/{policy} | Create or update a lifecycle policy |
| DELETE /_ilm/policy/{policy} | Delete a lifecycle policy |
| GET /{index}/_ilm/explain | Explain the lifecycle state |
| GET /_ilm/policy | Get lifecycle policies |
| GET /_ilm/status | Get the ILM status |
| POST /_ilm/migrate_to_data_tiers | Migrate to data tiers routing |
| POST /_ilm/move/{index} | Move to a lifecycle step |
| POST /{index}/_ilm/remove | Remove policies from an index |
| POST /{index}/_ilm/retry | Retry a policy |
| POST /_ilm/start | Start the ILM plugin |
| POST /_ilm/stop | Stop the ILM plugin |
| Shortcut | Action |
|---|---|
| GET /_scripts/{id} | Get a script or search template |
| PUT /_scripts/{id} | Create or update a script or search template |
| POST /_scripts/{id} | Create or update a script or search template |
| DELETE /_scripts/{id} | Delete a script or search template |
| GET /_script_context | Get script contexts |
| GET /_script_language | Get script languages |
| PUT /_scripts/{id}/{context} | Create or update a script or search template |
| POST /_scripts/{id}/{context} | Create or update a script or search template |
| GET /_scripts/painless/_execute | Run a script |
| POST /_scripts/painless/_execute | Run a script |
| Shortcut | Action |
|---|---|
| GET /_slm/policy/{policy_id} | Get policy information |
| PUT /_slm/policy/{policy_id} | Create or update a policy |
| DELETE /_slm/policy/{policy_id} | Delete a policy |
| PUT /_slm/policy/{policy_id}/_execute | Run a policy |
| POST /_slm/_execute_retention | Run a retention policy |
| GET /_slm/policy | Get policy information |
| GET /_slm/stats | Get snapshot lifecycle management statistics |
| GET /_slm/status | Get the snapshot lifecycle management status |
| POST /_slm/start | Start snapshot lifecycle management |
| POST /_slm/stop | Stop snapshot lifecycle management |
| Shortcut | Action |
|---|---|
| POST /_migration/reindex/{index}/_cancel | Cancel a migration reindex operation |
| PUT /_create_from/{source}/{dest} | Create an index from a source index |
| POST /_create_from/{source}/{dest} | Create an index from a source index |
| GET /_migration/reindex/{index}/_status | Get the migration reindexing status |
| POST /_migration/reindex | Reindex legacy backing indices |
| GET /_migration/deprecations | Get deprecation information |
| GET /{index}/_migration/deprecations | Get deprecation information |
| GET /_migration/system_features | Get feature migration information |
| POST /_migration/system_features | Start the feature migration |
| Shortcut | Action |
|---|---|
| GET /_license | Get license information |
| PUT /_license | Update the license |
| POST /_license | Update the license |
| DELETE /_license | Delete the license |
| GET /_license/basic_status | Get the basic license status |
| GET /_license/trial_status | Get the trial status |
| POST /_license/start_basic | Start a basic license |
| POST /_license/start_trial | Start a trial |
| Shortcut | Action |
|---|---|
| POST /_sql/close | Clear an SQL search cursor |
| DELETE /_sql/async/delete/{id} | Delete an async SQL search |
| GET /_sql/async/{id} | Get async SQL search results |
| GET /_sql/async/status/{id} | Get the async SQL search status |
| GET /_sql | Get SQL search results |
| POST /_sql | Get SQL search results |
| GET /_sql/translate | Translate SQL into Elasticsearch queries |
| POST /_sql/translate | Translate SQL into Elasticsearch queries |
| Shortcut | Action |
|---|---|
| GET /_synonyms/{id} | Get a synonym set |
| PUT /_synonyms/{id} | Create or update a synonym set |
| DELETE /_synonyms/{id} | Delete a synonym set |
| GET /_synonyms/{set_id}/{rule_id} | Get a synonym rule |
| PUT /_synonyms/{set_id}/{rule_id} | Create or update a synonym rule |
| DELETE /_synonyms/{set_id}/{rule_id} | Delete a synonym rule |
| GET /_synonyms | Get all synonym sets |
| Shortcut | Action |
|---|---|
| GET /_enrich/policy/{name} | Get an enrich policy |
| PUT /_enrich/policy/{name} | Create an enrich policy |
| DELETE /_enrich/policy/{name} | Delete an enrich policy |
| PUT /_enrich/policy/{name}/_execute | Run an enrich policy |
| GET /_enrich/policy | Get an enrich policy |
| GET /_enrich/_stats | Get enrich stats |
| Shortcut | Action |
|---|---|
| GET /_eql/search/{id} | Get async EQL search results |
| DELETE /_eql/search/{id} | Delete an async EQL search |
| GET /_eql/search/status/{id} | Get the async EQL status |
| GET /{index}/_eql/search | Get EQL search results |
| POST /{index}/_eql/search | Get EQL search results |
| Shortcut | Action |
|---|---|
| GET /_logstash/pipeline/{id} | Get Logstash pipelines |
| PUT /_logstash/pipeline/{id} | Create or update a Logstash pipeline |
| DELETE /_logstash/pipeline/{id} | Delete a Logstash pipeline |
| GET /_logstash/pipeline | Get Logstash pipelines |
| Shortcut | Action |
|---|---|
| POST /_tasks/_cancel | Cancel a task |
| POST /_tasks/{task_id}/_cancel | Cancel a task |
| GET /_tasks/{task_id} | Get task information |
| GET /_tasks | Get all tasks |
| Shortcut | Action |
|---|---|
| POST /_streams/{name}/_disable | Disable a named stream |
| POST /_streams/{name}/_enable | Enable a named stream |
| GET /_streams/status | Get the status of streams |
| Shortcut | Action |
|---|---|
| GET /_features | Get the features |
| POST /_features/_reset | Reset the features |
| Shortcut | Action |
|---|---|
| GET /{index}/_graph/explore | Explore graph analytics |
| POST /{index}/_graph/explore | Explore graph analytics |
| Shortcut | Action |
|---|---|
| GET /_xpack | Get information |
| GET /_xpack/usage | Get usage information |
Paths in braces are parameters: GET /{index} means GET /my-index. Many routes appear twice with GET and POST because Elasticsearch accepts a request body on either, and again with a /{index} prefix because most operations can be scoped to an index or run cluster-wide. Underscore-prefixed segments — _search, _cat, _cluster — are APIs; anything without an underscore is an index name.
GET /_cluster/health is the first call in any incident; GET /_cat/indices, GET /_cat/nodes and GET /_cat/allocation give the human-readable tables behind it, and GET /_cluster/allocation/explain says why a shard is unassigned. GET /_cat/pending_tasks and GET /_nodes/hot_threads are the next stops when the cluster is slow. GET /_cluster/settings and PUT /_cluster/settings read and change transient or persistent settings, and GET /_tasks lists long-running operations such as reindexes so they can be cancelled with POST /_tasks/{task_id}/_cancel.
Documents go in through PUT /{index}/_doc/{id} or, for anything more than a handful, POST /_bulk. GET /{index}/_doc/{id} fetches one, POST /{index}/_update/{id} patches one, and POST /{index}/_delete_by_query and POST /{index}/_update_by_query act on everything a query matches. Searching is POST /{index}/_search in practice, with POST /_count for totals, GET /{index}/_explain/{id} for why a document scored as it did, and POST /{index}/_pit plus search-after for deep pagination instead of scroll. POST /_reindex copies between indices, and PUT /_index_template/{name} defines mappings for indices that do not exist yet.
POST /_query runs an ES|QL query, the piped query language that has replaced SQL for most analytics use, with POST /_query/async for long ones. PUT /_inference/{task_type}/{inference_id} registers an embedding or chat model — local or a hosted provider — that ingest pipelines and semantic search can call. GET /_migration/deprecations is the pre-upgrade check.
Elasticsearch accepts a JSON body on GET for search and analysis APIs, but some HTTP clients cannot send one, so POST is offered as an equivalent.
A path parameter you replace: {index} is an index name or pattern, {id} a document ID, {name} a template or policy name.
GET /_cluster/allocation/explain, with an optional body naming the index and shard.
A point in time (POST /{index}/_pit) combined with search_after in the search body. Scroll still works but is not recommended for user-facing paging.
Open your assistant with this page preloaded as the source — great for follow-up questions like "which of these work in other apps?"