{ "_info": { "license": { "name": "Apache 2.0", "url": "https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE" }, "title": "Elasticsearch Request & Response Specification" }, "endpoints": [ { "availability": { "stack": { "stability": "experimental", "visibility": "private" } }, "description": "This API is a diagnostics API and the output should not be relied upon for building applications.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-desired-balance.html", "name": "_internal.delete_desired_balance", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_internal/desired_balance" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "private" } }, "description": "Deletes the desired nodes. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-desired-nodes.html", "name": "_internal.delete_desired_nodes", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_internal/desired_nodes" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "private" } }, "description": "This API is a diagnostics API and the output should not be relied upon for building applications.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-desired-balance.html", "name": "_internal.get_desired_balance", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_internal/desired_balance" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "private" } }, "description": "Gets the latest desired nodes. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-desired-nodes.html", "name": "_internal.get_desired_nodes", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_internal/desired_nodes/_latest" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "private" } }, "description": "Prevalidates node removal from the cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/prevalidate-node-removal-api.html", "name": "_internal.prevalidate_node_removal", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_internal/prevalidate_node_removal" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "private" } }, "description": "Updates the desired nodes. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-desired-nodes.html", "name": "_internal.update_desired_nodes", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_internal/desired_nodes/{history_id}/{version}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.7.0", "stability": "stable" } }, "description": "Delete an async search.\n\nIf the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", "name": "async_search.delete", "request": { "name": "Request", "namespace": "async_search.delete" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "async_search.delete" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_async_search/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.7.0", "stability": "stable" } }, "description": "Get async search results.\n\nRetrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", "name": "async_search.get", "request": { "name": "Request", "namespace": "async_search.get" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "async_search.get" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_async_search/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.11.0", "stability": "stable" } }, "description": "Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", "name": "async_search.status", "request": { "name": "Request", "namespace": "async_search.status" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "async_search.status" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_async_search/status/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.7.0", "stability": "stable" } }, "description": "Run an async search.\n\nWhen 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 become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", "name": "async_search.submit", "request": { "name": "Request", "namespace": "async_search.submit" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "async_search.submit" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_async_search" }, { "methods": [ "POST" ], "path": "/{index}/_async_search" } ] }, { "availability": { "stack": { "since": "7.11.0", "stability": "stable" } }, "description": "Delete an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "docId": "autoscaling-delete-autoscaling-policy", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-delete-autoscaling-policy.html", "extDocId": "autoscaling", "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.delete_autoscaling_policy", "request": { "name": "Request", "namespace": "autoscaling.delete_autoscaling_policy" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "autoscaling.delete_autoscaling_policy" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_autoscaling/policy/{name}" } ] }, { "availability": { "stack": { "since": "7.11.0", "stability": "stable" } }, "description": "Get the autoscaling capacity.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nThis API gets the current autoscaling capacity based on the configured autoscaling policy.\nIt will return information to size the cluster appropriately to the current workload.\n\nThe `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy.\n\nThe operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information.\n\nThe response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required.\nThis information is provided for diagnosis only.\nDo not use this information to make autoscaling decisions.", "docId": "autoscaling-get-autoscaling-capacity", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-get-autoscaling-capacity.html", "extDocId": "autoscaling", "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.get_autoscaling_capacity", "request": { "name": "Request", "namespace": "autoscaling.get_autoscaling_capacity" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "autoscaling.get_autoscaling_capacity" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_autoscaling/capacity" } ] }, { "availability": { "stack": { "since": "7.11.0", "stability": "stable" } }, "description": "Get an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "docId": "autoscaling-get-autoscaling-capacity", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-get-autoscaling-capacity.html", "extDocId": "autoscaling", "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.get_autoscaling_policy", "request": { "name": "Request", "namespace": "autoscaling.get_autoscaling_policy" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "autoscaling.get_autoscaling_policy" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_autoscaling/policy/{name}" } ] }, { "availability": { "stack": { "since": "7.11.0", "stability": "stable" } }, "description": "Create or update an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "docId": "autoscaling-put-autoscaling-policy", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-put-autoscaling-policy.html", "extDocId": "autoscaling", "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.put_autoscaling_policy", "request": { "name": "Request", "namespace": "autoscaling.put_autoscaling_policy" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "autoscaling.put_autoscaling_policy" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_autoscaling/policy/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Bulk index or delete documents.\nPerforms multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "docId": "docs-bulk", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-bulk.html", "name": "bulk", "request": { "name": "Request", "namespace": "_global.bulk" }, "requestBodyRequired": true, "requestMediaType": [ "application/x-ndjson" ], "response": { "name": "Response", "namespace": "_global.bulk" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST", "PUT" ], "path": "/_bulk" }, { "methods": [ "POST", "PUT" ], "path": "/{index}/_bulk" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "private" } }, "description": "Checks if the specified combination of method, API, parameters, and arbitrary capabilities are supported", "docUrl": "https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/README.asciidoc#require-or-skip-api-capabilities", "name": "capabilities", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_capabilities" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get aliases.\nRetrieves the cluster’s index aliases, including filter and routing information.\nThe API does not return data stream aliases.\n\nCAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.", "docId": "cat-alias", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-alias.html", "name": "cat.aliases", "privileges": { "index": [ "view_index_metadata" ] }, "request": { "name": "Request", "namespace": "cat.aliases" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.aliases" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/aliases" }, { "methods": [ "GET" ], "path": "/_cat/aliases/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Get shard allocation information.\nGet a snapshot of the number of shards allocated to each data node and their disk space.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "docId": "cat-allocation", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-allocation.html", "name": "cat.allocation", "privileges": { "cluster": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.allocation" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.allocation" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/allocation" }, { "methods": [ "GET" ], "path": "/_cat/allocation/{node_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.1.0", "stability": "stable" } }, "description": "Get component templates.\nReturns information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html", "name": "cat.component_templates", "privileges": { "cluster": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.component_templates" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.component_templates" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/component_templates" }, { "methods": [ "GET" ], "path": "/_cat/component_templates/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get a document count.\nProvides quick access to a document count for a data stream, an index, or an entire cluster.\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", "docId": "cat-count", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-count.html", "name": "cat.count", "privileges": { "index": [ "read" ] }, "request": { "name": "Request", "namespace": "cat.count" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.count" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/count" }, { "methods": [ "GET" ], "path": "/_cat/count/{index}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Get field data cache information.\nGet the amount of heap memory currently used by the field data cache on every data node in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", "docId": "cat-fielddata", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-fielddata.html", "name": "cat.fielddata", "privileges": { "cluster": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.fielddata" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.fielddata" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/fielddata" }, { "methods": [ "GET" ], "path": "/_cat/fielddata/{fields}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Get the cluster health status.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.", "docId": "cat-health", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-health.html", "name": "cat.health", "privileges": { "cluster": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.health" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.health" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/health" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get CAT help.\nReturns help for the CAT APIs.", "docId": "cat", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat.html", "name": "cat.help", "request": { "name": "Request", "namespace": "cat.help" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.help" }, "responseMediaType": [ "text/plain" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get index information.\nReturns high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.", "docId": "cat-indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-indices.html", "name": "cat.indices", "privileges": { "cluster": [ "monitor" ], "index": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.indices" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.indices" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/indices" }, { "methods": [ "GET" ], "path": "/_cat/indices/{index}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Get master node information.\nGet information about the master node, including the ID, bound IP address, and name.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "docId": "cat-master", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-master.html", "name": "cat.master", "privileges": { "cluster": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.master" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.master" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/master" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.7.0", "stability": "stable" } }, "description": "Get data frame analytics jobs.\nReturns configuration and usage information about data frame analytics jobs.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", "docId": "cat-dfanalytics", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-dfanalytics.html", "name": "cat.ml_data_frame_analytics", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "cat.ml_data_frame_analytics" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.ml_data_frame_analytics" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/ml/data_frame/analytics" }, { "methods": [ "GET" ], "path": "/_cat/ml/data_frame/analytics/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.7.0", "stability": "stable" } }, "description": "Get datafeeds.\nReturns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", "docId": "cat-datafeeds", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-datafeeds.html", "name": "cat.ml_datafeeds", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "cat.ml_datafeeds" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.ml_datafeeds" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/ml/datafeeds" }, { "methods": [ "GET" ], "path": "/_cat/ml/datafeeds/{datafeed_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.7.0", "stability": "stable" } }, "description": "Get anomaly detection jobs.\nReturns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", "docId": "cat-anomaly-detectors", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-anomaly-detectors.html", "name": "cat.ml_jobs", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "cat.ml_jobs" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.ml_jobs" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/ml/anomaly_detectors" }, { "methods": [ "GET" ], "path": "/_cat/ml/anomaly_detectors/{job_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.7.0", "stability": "stable" } }, "description": "Get trained models.\nReturns configuration and usage information about inference trained models.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", "docId": "cat-trained-model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-trained-model.html", "name": "cat.ml_trained_models", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "cat.ml_trained_models" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.ml_trained_models" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/ml/trained_models" }, { "methods": [ "GET" ], "path": "/_cat/ml/trained_models/{model_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Get node attribute information.\nGet information about custom node attributes.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "docId": "cat-nodeattrs", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-nodeattrs.html", "name": "cat.nodeattrs", "privileges": { "cluster": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.nodeattrs" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.nodeattrs" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/nodeattrs" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Get node information.\nGet information about the nodes in a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "docId": "cat-nodes", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-nodes.html", "name": "cat.nodes", "privileges": { "cluster": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.nodes" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.nodes" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/nodes" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Get pending task information.\nGet information about cluster-level changes that have not yet taken effect.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.", "docId": "cat-pending-tasks", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-pending-tasks.html", "name": "cat.pending_tasks", "privileges": { "cluster": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.pending_tasks" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.pending_tasks" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/pending_tasks" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Get plugin information.\nGet a list of plugins running on each node of a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "docId": "cat-plugins", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-plugins.html", "name": "cat.plugins", "privileges": { "cluster": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.plugins" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.plugins" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/plugins" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Get shard recovery information.\nGet information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.", "docId": "cat-recovery", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-recovery.html", "name": "cat.recovery", "privileges": { "cluster": [ "monitor" ], "index": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.recovery" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.recovery" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/recovery" }, { "methods": [ "GET" ], "path": "/_cat/recovery/{index}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "2.1.0", "stability": "stable" } }, "description": "Get snapshot repository information.\nGet a list of snapshot repositories for a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.", "docId": "cat-repositories", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-repositories.html", "name": "cat.repositories", "privileges": { "cluster": [ "monitor_snapshot" ] }, "request": { "name": "Request", "namespace": "cat.repositories" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.repositories" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/repositories" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Get segment information.\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.", "docId": "cat-segments", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-segments.html", "name": "cat.segments", "privileges": { "cluster": [ "monitor" ], "index": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.segments" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.segments" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/segments" }, { "methods": [ "GET" ], "path": "/_cat/segments/{index}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Get shard information.\nGet information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "docId": "cat-shards", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-shards.html", "name": "cat.shards", "privileges": { "cluster": [ "monitor" ], "index": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.shards" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.shards" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/shards" }, { "methods": [ "GET" ], "path": "/_cat/shards/{index}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "2.1.0", "stability": "stable" } }, "description": "Get snapshot information\nGet information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.", "docId": "cat-snapshots", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-snapshots.html", "name": "cat.snapshots", "privileges": { "cluster": [ "monitor_snapshot" ] }, "request": { "name": "Request", "namespace": "cat.snapshots" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.snapshots" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/snapshots" }, { "methods": [ "GET" ], "path": "/_cat/snapshots/{repository}" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "private" }, "stack": { "since": "5.0.0", "stability": "experimental" } }, "description": "Get task information.\nGet information about tasks currently running in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.", "docId": "tasks", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", "name": "cat.tasks", "privileges": { "cluster": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.tasks" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.tasks" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/tasks" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.2.0", "stability": "stable" } }, "description": "Get index template information.\nGet information about the index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.", "docId": "cat-templates", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-templates.html", "name": "cat.templates", "privileges": { "cluster": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.templates" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.templates" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/templates" }, { "methods": [ "GET" ], "path": "/_cat/templates/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Get thread pool statistics.\nGet thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "docId": "cat-thread-pool", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-thread-pool.html", "name": "cat.thread_pool", "privileges": { "cluster": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cat.thread_pool" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.thread_pool" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/thread_pool" }, { "methods": [ "GET" ], "path": "/_cat/thread_pool/{thread_pool_patterns}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.7.0", "stability": "stable" } }, "description": "Get transform information.\nGet configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", "docId": "cat-transforms", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-transforms.html", "name": "cat.transforms", "privileges": { "cluster": [ "monitor_transform" ] }, "request": { "name": "Request", "namespace": "cat.transforms" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cat.transforms" }, "responseMediaType": [ "text/plain", "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cat/transforms" }, { "methods": [ "GET" ], "path": "/_cat/transforms/{transform_id}" } ] }, { "availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "description": "Deletes auto-follow patterns.", "docId": "ccr-delete-auto-follow-pattern", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-delete-auto-follow-pattern.html", "name": "ccr.delete_auto_follow_pattern", "request": { "name": "Request", "namespace": "ccr.delete_auto_follow_pattern" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ccr.delete_auto_follow_pattern" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ccr/auto_follow/{name}" } ] }, { "availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "description": "Creates a new follower index configured to follow the referenced leader index.", "docId": "ccr-put-follow", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-put-follow.html", "name": "ccr.follow", "request": { "name": "Request", "namespace": "ccr.follow" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ccr.follow" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/{index}/_ccr/follow" } ] }, { "availability": { "stack": { "since": "6.7.0", "stability": "stable" } }, "description": "Retrieves information about all follower indices, including parameters and status for each follower index", "docId": "ccr-get-follow-info", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-follow-info.html", "name": "ccr.follow_info", "request": { "name": "Request", "namespace": "ccr.follow_info" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ccr.follow_info" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/{index}/_ccr/info" } ] }, { "availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "description": "Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.", "docId": "ccr-get-follow-stats", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-follow-stats.html", "name": "ccr.follow_stats", "request": { "name": "Request", "namespace": "ccr.follow_stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ccr.follow_stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/{index}/_ccr/stats" } ] }, { "availability": { "stack": { "since": "6.7.0", "stability": "stable" } }, "description": "Removes the follower retention leases from the leader.", "docId": "ccr-post-forget-follower", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-forget-follower.html", "name": "ccr.forget_follower", "request": { "name": "Request", "namespace": "ccr.forget_follower" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ccr.forget_follower" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/{index}/_ccr/forget_follower" } ] }, { "availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "description": "Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.", "docId": "ccr-get-auto-follow-pattern", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-auto-follow-pattern.html", "name": "ccr.get_auto_follow_pattern", "request": { "name": "Request", "namespace": "ccr.get_auto_follow_pattern" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ccr.get_auto_follow_pattern" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ccr/auto_follow" }, { "methods": [ "GET" ], "path": "/_ccr/auto_follow/{name}" } ] }, { "availability": { "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Pauses an auto-follow pattern", "docId": "ccr-pause-auto-follow-pattern", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-pause-auto-follow-pattern.html", "name": "ccr.pause_auto_follow_pattern", "request": { "name": "Request", "namespace": "ccr.pause_auto_follow_pattern" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ccr.pause_auto_follow_pattern" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ccr/auto_follow/{name}/pause" } ] }, { "availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "description": "Pauses a follower index. The follower index will not fetch any additional operations from the leader index.", "docId": "ccr-post-pause-follow", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-pause-follow.html", "name": "ccr.pause_follow", "request": { "name": "Request", "namespace": "ccr.pause_follow" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ccr.pause_follow" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/{index}/_ccr/pause_follow" } ] }, { "availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "description": "Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.", "docId": "ccr-put-auto-follow-pattern", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-put-auto-follow-pattern.html", "name": "ccr.put_auto_follow_pattern", "request": { "name": "Request", "namespace": "ccr.put_auto_follow_pattern" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ccr.put_auto_follow_pattern" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_ccr/auto_follow/{name}" } ] }, { "availability": { "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Resumes an auto-follow pattern that has been paused", "docId": "ccr-resume-auto-follow-pattern", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-resume-auto-follow-pattern.html", "name": "ccr.resume_auto_follow_pattern", "request": { "name": "Request", "namespace": "ccr.resume_auto_follow_pattern" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ccr.resume_auto_follow_pattern" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ccr/auto_follow/{name}/resume" } ] }, { "availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "description": "Resumes a follower index that has been paused", "docId": "ccr-post-resume-follow", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-resume-follow.html", "name": "ccr.resume_follow", "request": { "name": "Request", "namespace": "ccr.resume_follow" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ccr.resume_follow" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/{index}/_ccr/resume_follow" } ] }, { "availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "description": "Gets all stats related to cross-cluster replication.", "docId": "ccr-get-stats", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-stats.html", "name": "ccr.stats", "request": { "name": "Request", "namespace": "ccr.stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ccr.stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ccr/stats" } ] }, { "availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "description": "Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.", "docId": "ccr-post-unfollow", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-unfollow.html", "name": "ccr.unfollow", "request": { "name": "Request", "namespace": "ccr.unfollow" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ccr.unfollow" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/{index}/_ccr/unfollow" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Clear a scrolling search.\n\nClear the search context and results for a scrolling search.", "docId": "clear-scroll-api", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-scroll-api.html", "name": "clear_scroll", "request": { "name": "Request", "namespace": "_global.clear_scroll" }, "requestBodyRequired": false, "requestMediaType": [ "application/json", "text/plain" ], "response": { "name": "Response", "namespace": "_global.clear_scroll" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_search/scroll" }, { "deprecation": { "description": "A scroll id can be quite large and should be specified as part of the body", "version": "7.0.0" }, "methods": [ "DELETE" ], "path": "/_search/scroll/{scroll_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.10.0", "stability": "stable" } }, "description": "Close a point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no longer required for search requests.", "docId": "point-in-time-api", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html", "name": "close_point_in_time", "request": { "name": "Request", "namespace": "_global.close_point_in_time" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.close_point_in_time" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_pit" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.0.0", "stability": "stable" } }, "description": "Provides explanations for shard allocations in the cluster.", "docId": "cluster-allocation-explain", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-allocation-explain.html", "name": "cluster.allocation_explain", "request": { "name": "Request", "namespace": "cluster.allocation_explain" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "cluster.allocation_explain" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_cluster/allocation/explain" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.8.0", "stability": "stable" } }, "description": "Delete component templates.\nDeletes component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", "docId": "indices-component-template", "docTag": "indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.delete_component_template", "privileges": { "cluster": [ "manage_index_templates" ] }, "request": { "name": "Request", "namespace": "cluster.delete_component_template" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cluster.delete_component_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_component_template/{name}" } ] }, { "availability": { "stack": { "since": "7.0.0", "stability": "stable" } }, "description": "Clears cluster voting config exclusions.", "docId": "voting-config-exclusions", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/voting-config-exclusions.html", "name": "cluster.delete_voting_config_exclusions", "request": { "name": "Request", "namespace": "cluster.delete_voting_config_exclusions" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cluster.delete_voting_config_exclusions" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_cluster/voting_config_exclusions" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.8.0", "stability": "stable" } }, "description": "Check component templates.\nReturns information about whether a particular component template exists.", "docId": "indices-component-template", "docTag": "indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.exists_component_template", "request": { "name": "Request", "namespace": "cluster.exists_component_template" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cluster.exists_component_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "HEAD" ], "path": "/_component_template/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.8.0", "stability": "stable" } }, "description": "Get component templates.\nRetrieves information about component templates.", "docId": "indices-component-template", "docTag": "indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.get_component_template", "privileges": { "cluster": [ "manage_index_templates" ] }, "request": { "name": "Request", "namespace": "cluster.get_component_template" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cluster.get_component_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_component_template" }, { "methods": [ "GET" ], "path": "/_component_template/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Returns cluster-wide settings.\nBy default, it returns only settings that have been explicitly defined.", "docId": "cluster-get-settings", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-get-settings.html", "name": "cluster.get_settings", "privileges": { "cluster": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cluster.get_settings" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cluster.get_settings" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cluster/settings" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "1.3.0", "stability": "stable" } }, "description": "The cluster health API returns a simple status on the health of the cluster. You 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 stream’s backing indices.\nThe cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status.", "docId": "cluster-health", "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-health.html", "name": "cluster.health", "privileges": { "cluster": [ "monitor", "manage" ] }, "request": { "name": "Request", "namespace": "cluster.health" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cluster.health" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cluster/health" }, { "methods": [ "GET" ], "path": "/_cluster/health/{index}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.9.0", "stability": "stable" } }, "description": "Get cluster info.\nReturns basic information about the cluster.", "docId": "cluster-info", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-info.html", "name": "cluster.info", "request": { "name": "Request", "namespace": "cluster.info" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cluster.info" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_info/{target}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.\nNOTE: This API returns a list of any pending updates to the cluster state.\nThese are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.\nHowever, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.", "docId": "cluster-pending", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-pending.html", "name": "cluster.pending_tasks", "privileges": { "cluster": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cluster.pending_tasks" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cluster.pending_tasks" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cluster/pending_tasks" } ] }, { "availability": { "stack": { "since": "7.0.0", "stability": "stable" } }, "description": "Updates the cluster voting config exclusions by node ids or node names.", "docId": "voting-config-exclusions", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/voting-config-exclusions.html", "name": "cluster.post_voting_config_exclusions", "request": { "name": "Request", "namespace": "cluster.post_voting_config_exclusions" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cluster.post_voting_config_exclusions" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_cluster/voting_config_exclusions" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.8.0", "stability": "stable" } }, "description": "Create or update a component template.\nCreates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", "docId": "indices-component-template", "docTag": "indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.put_component_template", "privileges": { "cluster": [ "manage_index_templates" ] }, "request": { "name": "Request", "namespace": "cluster.put_component_template" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "cluster.put_component_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_component_template/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Updates the cluster settings.", "docId": "cluster-update-settings", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-update-settings.html", "name": "cluster.put_settings", "request": { "name": "Request", "namespace": "cluster.put_settings" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "cluster.put_settings" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_cluster/settings" } ] }, { "availability": { "stack": { "since": "6.1.0", "stability": "stable" } }, "description": "The cluster remote info API allows you to retrieve all of the configured\nremote cluster information. It returns connection and endpoint information\nkeyed by the configured remote cluster alias.", "docId": "cluster-remote-info", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-remote-info.html", "name": "cluster.remote_info", "request": { "name": "Request", "namespace": "cluster.remote_info" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cluster.remote_info" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_remote/info" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.0.0", "stability": "stable" } }, "description": "Allows to manually change the allocation of individual shards in the cluster.", "docId": "cluster-reroute", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-reroute.html", "name": "cluster.reroute", "request": { "name": "Request", "namespace": "cluster.reroute" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "cluster.reroute" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_cluster/reroute" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "1.3.0", "stability": "stable" } }, "description": "Returns a comprehensive information about the state of the cluster.", "docId": "cluster-state", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-state.html", "name": "cluster.state", "privileges": { "cluster": [ "monitor", "manage" ] }, "request": { "name": "Request", "namespace": "cluster.state" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cluster.state" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cluster/state" }, { "methods": [ "GET" ], "path": "/_cluster/state/{metric}" }, { "methods": [ "GET" ], "path": "/_cluster/state/{metric}/{index}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "1.3.0", "stability": "stable" } }, "description": "Returns cluster statistics.\nIt returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).", "docId": "cluster-stats", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-stats.html", "name": "cluster.stats", "privileges": { "cluster": [ "monitor" ] }, "request": { "name": "Request", "namespace": "cluster.stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "cluster.stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_cluster/stats" }, { "methods": [ "GET" ], "path": "/_cluster/stats/nodes/{node_id}" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "experimental" } }, "description": "Check in a connector.\n\nUpdate the `last_seen` field in the connector and set it to the current timestamp.", "docId": "connector-checkin", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/check-in-connector-api.html", "name": "connector.check_in", "request": { "name": "Request", "namespace": "connector.check_in" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "connector.check_in" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_check_in" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Delete a connector.\n\nRemoves a connector and associated sync jobs.\nThis is a destructive action that is not recoverable.\nNOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.\nThese need to be removed manually.", "docId": "connector-delete", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-api.html", "name": "connector.delete", "request": { "name": "Request", "namespace": "connector.delete" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "connector.delete" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_connector/{connector_id}" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Get a connector.\n\nGet the details about a connector.", "docId": "connector-get", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-api.html", "name": "connector.get", "request": { "name": "Request", "namespace": "connector.get" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "connector.get" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_connector/{connector_id}" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "private" }, "stack": { "since": "8.12.0", "stability": "experimental", "visibility": "private" } }, "description": "Update the connector last sync stats.\n\nUpdate the fields related to the last sync of a connector.\nThis action is used for analytics and monitoring.", "docId": "connector-last-sync", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-last-sync-api.html", "name": "connector.last_sync", "request": { "name": "Request", "namespace": "connector.last_sync" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.last_sync" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_last_sync" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Get all connectors.\n\nGet information about all connectors.", "docId": "connector-list", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-api.html", "name": "connector.list", "request": { "name": "Request", "namespace": "connector.list" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "connector.list" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_connector" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Create a connector.\n\nConnectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.\nElastic managed connectors (Native connectors) are a managed service on Elastic Cloud.\nSelf-managed connectors (Connector clients) are self-managed on your infrastructure.", "docId": "connector-post", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-api.html", "name": "connector.post", "request": { "name": "Request", "namespace": "connector.post" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.post" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_connector" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Create or update a connector.", "docId": "connector-put", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-api.html", "name": "connector.put", "request": { "name": "Request", "namespace": "connector.put" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.put" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}" }, { "methods": [ "PUT" ], "path": "/_connector" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "private" } }, "description": "Deletes a connector secret.", "docUrl": null, "name": "connector.secret_delete", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_connector/_secret/{id}" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "private" } }, "description": "Retrieves a secret stored by Connectors.", "docUrl": null, "name": "connector.secret_get", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_connector/_secret/{id}" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "private" } }, "description": "Creates a secret for a Connector.", "docUrl": null, "name": "connector.secret_post", "request": null, "requestBodyRequired": true, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_connector/_secret" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "private" } }, "description": "Creates or updates a secret for a Connector.", "docUrl": null, "name": "connector.secret_put", "request": null, "requestBodyRequired": true, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/_secret/{id}" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Cancel a connector sync job.\n\nCancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time.\nThe connector service is then responsible for setting the status of connector sync jobs to cancelled.", "docId": "connector-sync-job-cancel", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cancel-connector-sync-job-api.html", "name": "connector.sync_job_cancel", "request": { "name": "Request", "namespace": "connector.sync_job_cancel" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "connector.sync_job_cancel" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/_sync_job/{connector_sync_job_id}/_cancel" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "description": "Checks in a connector sync job (refreshes 'last_seen').", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/check-in-connector-sync-job-api.html", "name": "connector.sync_job_check_in", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/_sync_job/{connector_sync_job_id}/_check_in" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "description": "Claims a connector sync job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/claim-connector-sync-job-api.html", "name": "connector.sync_job_claim", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/_sync_job/{connector_sync_job_id}/_claim" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Delete a connector sync job.\n\nRemove a connector sync job and its associated data.\nThis is a destructive action that is not recoverable.", "docId": "connector-sync-job-delete", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-sync-job-api.html", "name": "connector.sync_job_delete", "request": { "name": "Request", "namespace": "connector.sync_job_delete" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "connector.sync_job_delete" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_connector/_sync_job/{connector_sync_job_id}" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "description": "Sets an error for a connector sync job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-error-api.html", "name": "connector.sync_job_error", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/_sync_job/{connector_sync_job_id}/_error" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Get a connector sync job.", "docId": "connector-sync-job-get", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-sync-job-api.html", "name": "connector.sync_job_get", "request": { "name": "Request", "namespace": "connector.sync_job_get" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "connector.sync_job_get" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_connector/_sync_job/{connector_sync_job_id}" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order.", "docId": "connector-sync-job-list", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-sync-jobs-api.html", "name": "connector.sync_job_list", "request": { "name": "Request", "namespace": "connector.sync_job_list" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "connector.sync_job_list" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_connector/_sync_job" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Create a connector sync job.\n\nCreate a connector sync job document in the internal index and initialize its counters and timestamps with default values.", "docId": "connector-sync-job-post", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-sync-job-api.html", "name": "connector.sync_job_post", "request": { "name": "Request", "namespace": "connector.sync_job_post" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.sync_job_post" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_connector/_sync_job" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "description": "Updates the stats fields in the connector sync job document.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-stats-api.html", "name": "connector.sync_job_update_stats", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/_sync_job/{connector_sync_job_id}/_stats" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "experimental" } }, "description": "Activate the connector draft filter.\n\nActivates the valid draft filtering for a connector.", "docId": "connector-update-filtering", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-api.html", "name": "connector.update_active_filtering", "request": { "name": "Request", "namespace": "connector.update_active_filtering" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.update_active_filtering" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_filtering/_activate" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Update the connector API key ID.\n\nUpdate the `api_key_id` and `api_key_secret_id` fields of a connector.\nYou can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.\nThe connector secret ID is required only for Elastic managed (native) connectors.\nSelf-managed connectors (connector clients) do not use this field.", "docId": "connector-update-api-key-id", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-api-key-id-api.html", "name": "connector.update_api_key_id", "request": { "name": "Request", "namespace": "connector.update_api_key_id" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.update_api_key_id" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_api_key_id" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Update the connector configuration.\n\nUpdate the configuration field in the connector document.", "docId": "connector-configuration", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-configuration-api.html", "name": "connector.update_configuration", "request": { "name": "Request", "namespace": "connector.update_configuration" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.update_configuration" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_configuration" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "experimental" } }, "description": "Update the connector error field.\n\nSet the error field for the connector.\nIf the error provided in the request body is non-null, the connector’s status is updated to error.\nOtherwise, if the error is reset to null, the connector status is updated to connected.", "docId": "connector-update-error", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-error-api.html", "name": "connector.update_error", "request": { "name": "Request", "namespace": "connector.update_error" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.update_error" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_error" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "description": "Updates the connector features in the connector document.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-features-api.html", "name": "connector.update_features", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_features" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Update the connector filtering.\n\nUpdate the draft filtering configuration of a connector and marks the draft validation state as edited.\nThe filtering draft is activated once validated by the running Elastic connector service.\nThe filtering property is used to configure sync rules (both basic and advanced) for a connector.", "docId": "connector-update-filtering", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-api.html", "name": "connector.update_filtering", "request": { "name": "Request", "namespace": "connector.update_filtering" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.update_filtering" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_filtering" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "experimental" } }, "description": "Update the connector draft filtering validation.\n\nUpdate the draft filtering validation info for a connector.", "docId": "connector-update-filtering-validation", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-validation-api.html", "name": "connector.update_filtering_validation", "request": { "name": "Request", "namespace": "connector.update_filtering_validation" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.update_filtering_validation" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_filtering/_validation" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Update the connector index name.\n\nUpdate the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored.", "docId": "connector-update-index-name", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-index-name-api.html", "name": "connector.update_index_name", "request": { "name": "Request", "namespace": "connector.update_index_name" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.update_index_name" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_index_name" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Update the connector name and description.", "docId": "connector-update-name", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-name-description-api.html", "name": "connector.update_name", "request": { "name": "Request", "namespace": "connector.update_name" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.update_name" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_name" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Update the connector is_native flag.", "docId": "connector-update-native", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-native-api.html", "name": "connector.update_native", "request": { "name": "Request", "namespace": "connector.update_native" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.update_native" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_native" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Update the connector pipeline.\n\nWhen you create a new connector, the configuration of an ingest pipeline is populated with default settings.", "docId": "connector-update-pipeline", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-pipeline-api.html", "name": "connector.update_pipeline", "request": { "name": "Request", "namespace": "connector.update_pipeline" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.update_pipeline" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_pipeline" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Update the connector scheduling.", "docId": "connector-update-scheduling", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-scheduling-api.html", "name": "connector.update_scheduling", "request": { "name": "Request", "namespace": "connector.update_scheduling" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.update_scheduling" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_scheduling" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "beta" } }, "description": "Update the connector service type.", "docId": "connector-update-service-type", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-service-type-api.html", "name": "connector.update_service_type", "request": { "name": "Request", "namespace": "connector.update_service_type" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.update_service_type" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_service_type" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "public" }, "stack": { "since": "8.12.0", "stability": "experimental" } }, "description": "Update the connector status.", "docId": "connector-update-status", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-status-api.html", "name": "connector.update_status", "request": { "name": "Request", "namespace": "connector.update_status" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "connector.update_status" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_connector/{connector_id}/_status" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Count search results.\nGet the number of documents matching a query.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html", "name": "count", "request": { "name": "Request", "namespace": "_global.count" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.count" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST", "GET" ], "path": "/_count" }, { "methods": [ "POST", "GET" ], "path": "/{index}/_count" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.0.0", "stability": "stable" } }, "description": "Index a document.\nAdds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", "name": "create", "request": { "name": "Request", "namespace": "_global.create" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.create" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/{index}/_create/{id}" } ] }, { "availability": { "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Delete a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", "docTag": "indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "name": "dangling_indices.delete_dangling_index", "request": { "name": "Request", "namespace": "dangling_indices.delete_dangling_index" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "dangling_indices.delete_dangling_index" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_dangling/{index_uuid}" } ] }, { "availability": { "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Import a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", "docTag": "indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "name": "dangling_indices.import_dangling_index", "request": { "name": "Request", "namespace": "dangling_indices.import_dangling_index" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "dangling_indices.import_dangling_index" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_dangling/{index_uuid}" } ] }, { "availability": { "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Get the dangling indices.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.\n\nUse this API to list dangling indices, which you can then import or delete.", "docTag": "indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "name": "dangling_indices.list_dangling_indices", "request": { "name": "Request", "namespace": "dangling_indices.list_dangling_indices" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "dangling_indices.list_dangling_indices" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_dangling" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Delete a document.\nRemoves a JSON document from the specified index.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html", "name": "delete", "request": { "name": "Request", "namespace": "_global.delete" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.delete" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/{index}/_doc/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.0.0", "stability": "stable" } }, "description": "Delete documents.\nDeletes documents that match the specified query.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html", "name": "delete_by_query", "request": { "name": "Request", "namespace": "_global.delete_by_query" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.delete_by_query" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/{index}/_delete_by_query" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "6.5.0", "stability": "stable" } }, "description": "Throttle a delete by query operation.\n\nChange the number of requests per second for a particular delete by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html", "name": "delete_by_query_rethrottle", "request": { "name": "Request", "namespace": "_global.delete_by_query_rethrottle" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.delete_by_query_rethrottle" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_delete_by_query/{task_id}/_rethrottle" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Delete a script or search template.\nDeletes a stored script or search template.", "docTag": "script", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "delete_script", "request": { "name": "Request", "namespace": "_global.delete_script" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.delete_script" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_scripts/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Delete an enrich policy.\nDeletes an existing enrich policy and its enrich index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html", "name": "enrich.delete_policy", "request": { "name": "Request", "namespace": "enrich.delete_policy" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "enrich.delete_policy" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_enrich/policy/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Run an enrich policy.\nCreate the enrich index for an existing enrich policy.", "docId": "execute-enrich-policy-api", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/execute-enrich-policy-api.html", "name": "enrich.execute_policy", "request": { "name": "Request", "namespace": "enrich.execute_policy" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "enrich.execute_policy" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_enrich/policy/{name}/_execute" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Get an enrich policy.\nReturns information about an enrich policy.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html", "name": "enrich.get_policy", "request": { "name": "Request", "namespace": "enrich.get_policy" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "enrich.get_policy" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_enrich/policy/{name}" }, { "methods": [ "GET" ], "path": "/_enrich/policy" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Create an enrich policy.\nCreates an enrich policy.", "docId": "put-enrich-policy-api", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-enrich-policy-api.html", "name": "enrich.put_policy", "request": { "name": "Request", "namespace": "enrich.put_policy" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "enrich.put_policy" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_enrich/policy/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Get enrich stats.\nReturns enrich coordinator statistics and information about enrich policies that are currently executing.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html", "name": "enrich.stats", "request": { "name": "Request", "namespace": "enrich.stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "enrich.stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_enrich/_stats" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Delete an async EQL search.\nDelete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "name": "eql.delete", "request": { "name": "Request", "namespace": "eql.delete" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "eql.delete" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_eql/search/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Get async EQL search results.\nGet the current status and available results for an async EQL search or a stored synchronous EQL search.", "docId": "eql-async-search-api", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-search-api.html", "name": "eql.get", "request": { "name": "Request", "namespace": "eql.get" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "eql.get" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_eql/search/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Get the async EQL status.\nGet the current status for an async EQL search or a stored synchronous EQL search without returning results.", "docId": "eql-async-search-status-api", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-status-api.html", "name": "eql.get_status", "request": { "name": "Request", "namespace": "eql.get_status" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "eql.get_status" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_eql/search/status/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Get EQL search results.\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "extDocId": "eql", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html", "name": "eql.search", "request": { "name": "Request", "namespace": "eql.search" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "eql.search" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/{index}/_eql/search" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Executes an ESQL request asynchronously", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-api.html", "name": "esql.async_query", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_query/async" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Retrieves the results of a previously submitted async query request given its ID.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-get-api.html", "name": "esql.async_query_get", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_query/async/{id}" } ] }, { "availability": { "serverless": {}, "stack": { "since": "8.11.0" } }, "description": "Run an ES|QL query.\nGet search results for an ES|QL (Elasticsearch query language) query.", "docId": "esql-query", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html", "extDocId": "esql", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql.html", "name": "esql.query", "request": { "name": "Request", "namespace": "esql.query" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "esql.query" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_query" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Check a document.\nChecks if a specified document exists.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "exists", "request": { "name": "Request", "namespace": "_global.exists" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.exists" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "HEAD" ], "path": "/{index}/_doc/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Check for a document source.\nChecks if a document's `_source` is stored.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "exists_source", "request": { "name": "Request", "namespace": "_global.exists_source" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.exists_source" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "HEAD" ], "path": "/{index}/_source/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Explain a document match result.\nReturns information about why a specific document matches, or doesn’t match, a query.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html", "name": "explain", "request": { "name": "Request", "namespace": "_global.explain" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.explain" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/{index}/_explain/{id}" } ] }, { "availability": { "stack": { "since": "7.12.0", "stability": "stable" } }, "description": "Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-features-api.html", "name": "features.get_features", "request": { "name": "Request", "namespace": "features.get_features" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "features.get_features" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_features" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "private" }, "stack": { "since": "7.12.0", "stability": "experimental" } }, "description": "Resets the internal state of features, usually by deleting system indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "features.reset_features", "request": { "name": "Request", "namespace": "features.reset_features" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "features.reset_features" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_features/_reset" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Get the field capabilities.\n\nGet information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html", "name": "field_caps", "privileges": { "index": [ "view_index_metadata", "read", "manage" ] }, "request": { "name": "Request", "namespace": "_global.field_caps" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.field_caps" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_field_caps" }, { "methods": [ "GET", "POST" ], "path": "/{index}/_field_caps" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "private" } }, "description": "Deletes a secret stored by Fleet.", "docUrl": null, "name": "fleet.delete_secret", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_fleet/secret/{id}" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "private" } }, "description": "Retrieves a secret stored by Fleet.", "docUrl": null, "name": "fleet.get_secret", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_fleet/secret/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.13.0", "stability": "stable" } }, "description": "Get global checkpoints.\nGet the current global checkpoints for an index.\nThis API is designed for internal use by the Fleet server project.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-global-checkpoints.html", "name": "fleet.global_checkpoints", "request": { "name": "Request", "namespace": "fleet.global_checkpoints" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "fleet.global_checkpoints" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/{index}/_fleet/global_checkpoints" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "private" }, "stack": { "since": "7.16.0", "stability": "experimental" } }, "description": "Run multiple Fleet searches.\nRun several Fleet searches with a single API request.\nThe API follows the same structure as the multi search API.\nHowever, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.", "docUrl": null, "name": "fleet.msearch", "privileges": { "index": [ "read" ] }, "request": { "name": "Request", "namespace": "fleet.msearch" }, "requestBodyRequired": true, "requestMediaType": [ "application/x-ndjson" ], "response": { "name": "Response", "namespace": "fleet.msearch" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_fleet/_fleet_msearch" }, { "methods": [ "GET", "POST" ], "path": "/{index}/_fleet/_fleet_msearch" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "private" } }, "description": "Creates a secret stored by Fleet.", "docUrl": null, "name": "fleet.post_secret", "request": null, "requestBodyRequired": true, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_fleet/secret" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "private" }, "stack": { "since": "7.16.0", "stability": "experimental" } }, "description": "Run a Fleet search.\nThe purpose of the Fleet search API is to provide an API where the search will be run only\nafter the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.", "docUrl": null, "name": "fleet.search", "privileges": { "index": [ "read" ] }, "request": { "name": "Request", "namespace": "fleet.search" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "fleet.search" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/{index}/_fleet/_fleet_search" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get a document by its ID.\nRetrieves the document with the specified ID from an index.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "get", "request": { "name": "Request", "namespace": "_global.get" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.get" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/{index}/_doc/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get a script or search template.\nRetrieves a stored script or search template.", "docTag": "script", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "get_script", "request": { "name": "Request", "namespace": "_global.get_script" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.get_script" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_scripts/{id}" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Get script contexts.\n\nGet a list of supported script contexts and their methods.", "docTag": "script", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html", "name": "get_script_context", "request": { "name": "Request", "namespace": "_global.get_script_context" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.get_script_context" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_script_context" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Get script languages.\n\nGet a list of available script types, languages, and contexts.", "docTag": "script", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "get_script_languages", "request": { "name": "Request", "namespace": "_global.get_script_languages" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.get_script_languages" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_script_language" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get a document's source.\nReturns the source of a document.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "get_source", "request": { "name": "Request", "namespace": "_global.get_source" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.get_source" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/{index}/_source/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Explore graph analytics.\nExtract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behavior of this API is to use the Graph UI to explore connections.\nAn initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", "docId": "graph-explore-api", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/graph-explore-api.html", "extDocId": "graph", "extDocUrl": "https://www.elastic.co/guide/en/kibana/{branch}/xpack-graph.html", "name": "graph.explore", "request": { "name": "Request", "namespace": "graph.explore" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "graph.explore" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/{index}/_graph/explore" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.7.0", "stability": "stable" } }, "description": "Returns the health of the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html", "name": "health_report", "request": { "name": "Request", "namespace": "_global.health_report" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.health_report" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_health_report" }, { "methods": [ "GET" ], "path": "/_health_report/{feature}" } ] }, { "availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "description": "Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html", "name": "ilm.delete_lifecycle", "privileges": { "cluster": [ "manage_ilm" ] }, "request": { "name": "Request", "namespace": "ilm.delete_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ilm.delete_lifecycle" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ilm/policy/{policy}" } ] }, { "availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "description": "Retrieves information about the index’s current lifecycle state, such as the currently executing phase, action, and step. Shows when the index entered each one, the definition of the running phase, and information about any failures.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html", "name": "ilm.explain_lifecycle", "privileges": { "index": [ "view_index_metadata", "manage_ilm" ] }, "request": { "name": "Request", "namespace": "ilm.explain_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ilm.explain_lifecycle" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/{index}/_ilm/explain" } ] }, { "availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "description": "Retrieves a lifecycle policy.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html", "name": "ilm.get_lifecycle", "privileges": { "cluster": [ "manage_ilm", "read_ilm" ] }, "request": { "name": "Request", "namespace": "ilm.get_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ilm.get_lifecycle" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ilm/policy/{policy}" }, { "methods": [ "GET" ], "path": "/_ilm/policy" } ] }, { "availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "description": "Retrieves the current index lifecycle management (ILM) status.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html", "name": "ilm.get_status", "request": { "name": "Request", "namespace": "ilm.get_status" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ilm.get_status" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ilm/status" } ] }, { "availability": { "stack": { "since": "7.14.0", "stability": "stable" } }, "description": "Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and\nattribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+\nUsing node roles enables ILM to automatically move the indices between data tiers.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html", "name": "ilm.migrate_to_data_tiers", "request": { "name": "Request", "namespace": "ilm.migrate_to_data_tiers" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ilm.migrate_to_data_tiers" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ilm/migrate_to_data_tiers" } ] }, { "availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "description": "Manually moves an index into the specified step and executes that step.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html", "name": "ilm.move_to_step", "request": { "name": "Request", "namespace": "ilm.move_to_step" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ilm.move_to_step" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ilm/move/{index}" } ] }, { "availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "description": "Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html", "name": "ilm.put_lifecycle", "privileges": { "cluster": [ "manage_ilm" ], "index": [ "manage" ] }, "request": { "name": "Request", "namespace": "ilm.put_lifecycle" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ilm.put_lifecycle" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_ilm/policy/{policy}" } ] }, { "availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "description": "Removes the assigned lifecycle policy and stops managing the specified index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html", "name": "ilm.remove_policy", "request": { "name": "Request", "namespace": "ilm.remove_policy" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ilm.remove_policy" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/{index}/_ilm/remove" } ] }, { "availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "description": "Retries executing the policy for an index that is in the ERROR step.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html", "name": "ilm.retry", "request": { "name": "Request", "namespace": "ilm.retry" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ilm.retry" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/{index}/_ilm/retry" } ] }, { "availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "description": "Start the index lifecycle management (ILM) plugin.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html", "name": "ilm.start", "request": { "name": "Request", "namespace": "ilm.start" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ilm.start" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ilm/start" } ] }, { "availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "description": "Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html", "name": "ilm.stop", "request": { "name": "Request", "namespace": "ilm.stop" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ilm.stop" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ilm/stop" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Index a document.\nAdds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", "name": "index", "request": { "name": "Request", "namespace": "_global.index" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.index" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/{index}/_doc/{id}" }, { "methods": [ "POST" ], "path": "/{index}/_doc" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Add an index block.\nLimits the operations allowed on an index by blocking specific operation types.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html", "name": "indices.add_block", "request": { "name": "Request", "namespace": "indices.add_block" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.add_block" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/{index}/_block/{block}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get tokens from text analysis.\nThe analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "docId": "indices-analyze", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-analyze.html", "name": "indices.analyze", "request": { "name": "Request", "namespace": "indices.analyze" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.analyze" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_analyze" }, { "methods": [ "GET", "POST" ], "path": "/{index}/_analyze" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Clears the caches of one or more indices.\nFor data streams, the API clears the caches of the stream’s backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html", "name": "indices.clear_cache", "request": { "name": "Request", "namespace": "indices.clear_cache" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.clear_cache" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_cache/clear" }, { "methods": [ "POST" ], "path": "/{index}/_cache/clear" } ] }, { "availability": { "stack": { "since": "7.4.0", "stability": "stable" } }, "description": "Clones an existing index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html", "name": "indices.clone", "request": { "name": "Request", "namespace": "indices.clone" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.clone" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/{index}/_clone/{target}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Closes an index.", "docId": "indices-close", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-close.html", "name": "indices.close", "request": { "name": "Request", "namespace": "indices.close" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.close" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/{index}/_close" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Create an index.\nCreates a new index.", "docId": "indices-create-index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-index.html", "name": "indices.create", "privileges": { "index": [ "create_index", "manage" ] }, "request": { "name": "Request", "namespace": "indices.create" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.create" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/{index}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Create a data stream.\nCreates a data stream.\nYou must have a matching index template with data stream enabled.", "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.create_data_stream", "privileges": { "index": [ "create_index" ] }, "request": { "name": "Request", "namespace": "indices.create_data_stream" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.create_data_stream" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_data_stream/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Get data stream stats.\nRetrieves statistics for one or more data streams.", "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.data_streams_stats", "privileges": { "index": [ "monitor" ] }, "request": { "name": "Request", "namespace": "indices.data_streams_stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.data_streams_stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_data_stream/_stats" }, { "methods": [ "GET" ], "path": "/_data_stream/{name}/_stats" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Delete indices.\nDeletes one or more indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html", "name": "indices.delete", "request": { "name": "Request", "namespace": "indices.delete" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.delete" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/{index}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Delete an alias.\nRemoves a data stream or index from an alias.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.delete_alias", "request": { "name": "Request", "namespace": "indices.delete_alias" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.delete_alias" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/{index}/_alias/{name}" }, { "methods": [ "DELETE" ], "path": "/{index}/_aliases/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.11.0", "stability": "stable" } }, "description": "Delete data stream lifecycles.\nRemoves the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html", "name": "indices.delete_data_lifecycle", "request": { "name": "Request", "namespace": "indices.delete_data_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.delete_data_lifecycle" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_data_stream/{name}/_lifecycle" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Delete data streams.\nDeletes one or more data streams and their backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.delete_data_stream", "privileges": { "index": [ "delete_index" ] }, "request": { "name": "Request", "namespace": "indices.delete_data_stream" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.delete_data_stream" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_data_stream/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.8.0", "stability": "stable" } }, "description": "Delete an index template.\nThe provided may contain multiple template names separated by a comma. If multiple template\nnames are specified then there is no wildcard support and the provided names should match completely with\nexisting templates.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html", "name": "indices.delete_index_template", "privileges": { "cluster": [ "manage_index_templates", "manage" ] }, "request": { "name": "Request", "namespace": "indices.delete_index_template" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.delete_index_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_index_template/{name}" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Deletes a legacy index template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template-v1.html", "name": "indices.delete_template", "privileges": { "cluster": [ "manage_index_templates", "manage" ] }, "request": { "name": "Request", "namespace": "indices.delete_template" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.delete_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_template/{name}" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "private" }, "stack": { "since": "7.15.0", "stability": "experimental" } }, "description": "Analyzes the disk usage of each field of an index or data stream.", "docId": "indices-disk-usage", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-disk-usage.html", "name": "indices.disk_usage", "request": { "name": "Request", "namespace": "indices.disk_usage" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.disk_usage" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/{index}/_disk_usage" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "private" }, "stack": { "since": "8.5.0", "stability": "experimental" } }, "description": "Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval.", "docId": "indices-downsample-data-stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-downsample-data-stream.html", "name": "indices.downsample", "request": { "name": "Request", "namespace": "indices.downsample" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.downsample" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/{index}/_downsample/{target_index}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Check indices.\nChecks if one or more indices, index aliases, or data streams exist.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html", "name": "indices.exists", "request": { "name": "Request", "namespace": "indices.exists" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.exists" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "HEAD" ], "path": "/{index}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Check aliases.\nChecks if one or more data stream or index aliases exist.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.exists_alias", "request": { "name": "Request", "namespace": "indices.exists_alias" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.exists_alias" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "HEAD" ], "path": "/_alias/{name}" }, { "methods": [ "HEAD" ], "path": "/{index}/_alias/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Check index templates.\nCheck whether index templates exist.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html", "name": "indices.exists_index_template", "request": { "name": "Request", "namespace": "indices.exists_index_template" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.exists_index_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "HEAD" ], "path": "/_index_template/{name}" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Check existence of index templates.\nReturns information about whether a particular index template exists.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-template-exists-v1.html", "name": "indices.exists_template", "request": { "name": "Request", "namespace": "indices.exists_template" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.exists_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "HEAD" ], "path": "/_template/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.11.0", "stability": "stable" } }, "description": "Get the status for a data stream lifecycle.\nRetrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html", "name": "indices.explain_data_lifecycle", "request": { "name": "Request", "namespace": "indices.explain_data_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.explain_data_lifecycle" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/{index}/_lifecycle/explain" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "private" }, "stack": { "since": "7.15.0", "stability": "experimental" } }, "description": "Returns field usage information for each shard and field of an index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/field-usage-stats.html", "name": "indices.field_usage_stats", "privileges": { "index": [ "manage" ] }, "request": { "name": "Request", "namespace": "indices.field_usage_stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.field_usage_stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/{index}/_field_usage_stats" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Flushes one or more data streams or indices.", "docId": "indices-flush", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-flush.html", "name": "indices.flush", "request": { "name": "Request", "namespace": "indices.flush" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.flush" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST", "GET" ], "path": "/_flush" }, { "methods": [ "POST", "GET" ], "path": "/{index}/_flush" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "2.1.0", "stability": "stable" } }, "description": "Performs the force merge operation on one or more indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html", "name": "indices.forcemerge", "request": { "name": "Request", "namespace": "indices.forcemerge" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.forcemerge" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_forcemerge" }, { "methods": [ "POST" ], "path": "/{index}/_forcemerge" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get index information.\nReturns information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html", "name": "indices.get", "privileges": { "index": [ "view_index_metadata", "manage" ] }, "request": { "name": "Request", "namespace": "indices.get" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.get" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/{index}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get aliases.\nRetrieves information for one or more data stream or index aliases.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.get_alias", "request": { "name": "Request", "namespace": "indices.get_alias" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.get_alias" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_alias" }, { "methods": [ "GET" ], "path": "/_alias/{name}" }, { "methods": [ "GET" ], "path": "/{index}/_alias/{name}" }, { "methods": [ "GET" ], "path": "/{index}/_alias" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.11.0", "stability": "stable" } }, "description": "Get data stream lifecycles.\nRetrieves the data stream lifecycle configuration of one or more data streams.", "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html", "name": "indices.get_data_lifecycle", "request": { "name": "Request", "namespace": "indices.get_data_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.get_data_lifecycle" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_data_stream/{name}/_lifecycle" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Get data streams.\nRetrieves information about one or more data streams.", "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.get_data_stream", "privileges": { "index": [ "view_index_metadata" ] }, "request": { "name": "Request", "namespace": "indices.get_data_stream" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.get_data_stream" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_data_stream" }, { "methods": [ "GET" ], "path": "/_data_stream/{name}" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Get mapping definitions.\nRetrieves mapping definitions for one or more fields.\nFor data streams, the API retrieves field mappings for the stream’s backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html", "name": "indices.get_field_mapping", "request": { "name": "Request", "namespace": "indices.get_field_mapping" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.get_field_mapping" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_mapping/field/{fields}" }, { "methods": [ "GET" ], "path": "/{index}/_mapping/field/{fields}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Get index templates.\nReturns information about one or more index templates.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html", "name": "indices.get_index_template", "privileges": { "cluster": [ "manage_index_templates", "manage" ] }, "request": { "name": "Request", "namespace": "indices.get_index_template" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.get_index_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_index_template" }, { "methods": [ "GET" ], "path": "/_index_template/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get mapping definitions.\nRetrieves mapping definitions for one or more indices.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html", "name": "indices.get_mapping", "request": { "name": "Request", "namespace": "indices.get_mapping" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.get_mapping" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_mapping" }, { "methods": [ "GET" ], "path": "/{index}/_mapping" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get index settings.\nReturns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html", "name": "indices.get_settings", "privileges": { "index": [ "view_index_metadata", "monitor", "manage" ] }, "request": { "name": "Request", "namespace": "indices.get_settings" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.get_settings" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_settings" }, { "methods": [ "GET" ], "path": "/{index}/_settings" }, { "methods": [ "GET" ], "path": "/{index}/_settings/{name}" }, { "methods": [ "GET" ], "path": "/_settings/{name}" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Get index templates.\nRetrieves information about one or more index templates.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template-v1.html", "name": "indices.get_template", "request": { "name": "Request", "namespace": "indices.get_template" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.get_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_template" }, { "methods": [ "GET" ], "path": "/_template/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Convert an index alias to a data stream.\nConverts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.migrate_to_data_stream", "privileges": { "index": [ "manage" ] }, "request": { "name": "Request", "namespace": "indices.migrate_to_data_stream" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.migrate_to_data_stream" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_data_stream/_migrate/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.16.0", "stability": "stable" } }, "description": "Update data streams.\nPerforms one or more data stream modification actions in a single atomic operation.", "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.modify_data_stream", "request": { "name": "Request", "namespace": "indices.modify_data_stream" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.modify_data_stream" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_data_stream/_modify" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Opens a closed index.\nFor data streams, the API opens any closed backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", "name": "indices.open", "request": { "name": "Request", "namespace": "indices.open" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.open" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/{index}/_open" } ] }, { "availability": { "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Promotes a data stream from a replicated data stream managed by CCR to a regular data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.promote_data_stream", "request": { "name": "Request", "namespace": "indices.promote_data_stream" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.promote_data_stream" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_data_stream/_promote/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Create or update an alias.\nAdds a data stream or index to an alias.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.put_alias", "request": { "name": "Request", "namespace": "indices.put_alias" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.put_alias" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/{index}/_alias/{name}" }, { "methods": [ "PUT", "POST" ], "path": "/{index}/_aliases/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.11.0", "stability": "stable" } }, "description": "Update data stream lifecycles.\nUpdate the data stream lifecycle of the specified data streams.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html", "name": "indices.put_data_lifecycle", "request": { "name": "Request", "namespace": "indices.put_data_lifecycle" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.put_data_lifecycle" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_data_stream/{name}/_lifecycle" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html", "name": "indices.put_index_template", "request": { "name": "Request", "namespace": "indices.put_index_template" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.put_index_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_index_template/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Update field mappings.\nAdds new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html", "name": "indices.put_mapping", "request": { "name": "Request", "namespace": "indices.put_mapping" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.put_mapping" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/{index}/_mapping" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Update index settings.\nChanges dynamic index settings in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html", "name": "indices.put_settings", "privileges": { "index": [ "manage" ] }, "request": { "name": "Request", "namespace": "indices.put_settings" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.put_settings" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_settings" }, { "methods": [ "PUT" ], "path": "/{index}/_settings" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html", "name": "indices.put_template", "request": { "name": "Request", "namespace": "indices.put_template" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.put_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_template/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Returns information about ongoing and completed shard recoveries for one or more indices.\nFor data streams, the API returns information for the stream’s backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html", "name": "indices.recovery", "request": { "name": "Request", "namespace": "indices.recovery" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.recovery" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_recovery" }, { "methods": [ "GET" ], "path": "/{index}/_recovery" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Refresh an index.\nA refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html", "name": "indices.refresh", "request": { "name": "Request", "namespace": "indices.refresh" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.refresh" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST", "GET" ], "path": "/_refresh" }, { "methods": [ "POST", "GET" ], "path": "/{index}/_refresh" } ] }, { "availability": { "stack": { "since": "7.3.0", "stability": "stable" } }, "description": "Reloads an index's search analyzers and their resources.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-reload-analyzers.html", "name": "indices.reload_search_analyzers", "request": { "name": "Request", "namespace": "indices.reload_search_analyzers" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.reload_search_analyzers" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/{index}/_reload_search_analyzers" } ] }, { "availability": { "stack": { "since": "8.13.0", "stability": "stable" } }, "description": "Resolves the specified index expressions to return information about each cluster, including\nthe local cluster, if included.\nMultiple patterns and remote clusters are supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-cluster-api.html", "name": "indices.resolve_cluster", "request": { "name": "Request", "namespace": "indices.resolve_cluster" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.resolve_cluster" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_resolve/cluster/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Resolve indices.\nResolve the names and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html", "name": "indices.resolve_index", "request": { "name": "Request", "namespace": "indices.resolve_index" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.resolve_index" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_resolve/index/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.0.0", "stability": "stable" } }, "description": "Roll over to a new index.\nCreates a new index for a data stream or index alias.", "docId": "indices-rollover-index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-rollover-index.html", "name": "indices.rollover", "request": { "name": "Request", "namespace": "indices.rollover" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.rollover" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/{alias}/_rollover" }, { "methods": [ "POST" ], "path": "/{alias}/_rollover/{new_index}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Returns low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the stream’s backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html", "name": "indices.segments", "request": { "name": "Request", "namespace": "indices.segments" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.segments" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_segments" }, { "methods": [ "GET" ], "path": "/{index}/_segments" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Retrieves store information about replica shards in one or more indices.\nFor data streams, the API retrieves store information for the stream’s backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html", "name": "indices.shard_stores", "request": { "name": "Request", "namespace": "indices.shard_stores" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.shard_stores" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_shard_stores" }, { "methods": [ "GET" ], "path": "/{index}/_shard_stores" } ] }, { "availability": { "stack": { "since": "5.0.0", "stability": "stable" } }, "description": "Shrinks an existing index into a new index with fewer primary shards.", "docId": "indices-shrink-index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-shrink-index.html", "name": "indices.shrink", "request": { "name": "Request", "namespace": "indices.shrink" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.shrink" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/{index}/_shrink/{target}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Simulate an index.\nReturns the index configuration that would be applied to the specified index from an existing index template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html", "name": "indices.simulate_index_template", "request": { "name": "Request", "namespace": "indices.simulate_index_template" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.simulate_index_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_index_template/_simulate_index/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Simulate an index template.\nReturns the index configuration that would be applied by a particular index template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html", "name": "indices.simulate_template", "privileges": { "cluster": [ "manage_index_templates", "manage" ] }, "request": { "name": "Request", "namespace": "indices.simulate_template" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.simulate_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_index_template/_simulate" }, { "methods": [ "POST" ], "path": "/_index_template/_simulate/{name}" } ] }, { "availability": { "stack": { "since": "6.1.0", "stability": "stable" } }, "description": "Splits an existing index into a new index with more primary shards.", "docId": "indices-split-index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-split-index.html", "name": "indices.split", "request": { "name": "Request", "namespace": "indices.split" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.split" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/{index}/_split/{target}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "1.3.0", "stability": "stable" } }, "description": "Returns statistics for one or more indices.\nFor data streams, the API retrieves statistics for the stream’s backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html", "name": "indices.stats", "privileges": { "index": [ "manage", "monitor" ] }, "request": { "name": "Request", "namespace": "indices.stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_stats" }, { "methods": [ "GET" ], "path": "/_stats/{metric}" }, { "methods": [ "GET" ], "path": "/{index}/_stats" }, { "methods": [ "GET" ], "path": "/{index}/_stats/{metric}" } ] }, { "availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "description": "Unfreezes an index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html", "name": "indices.unfreeze", "request": { "name": "Request", "namespace": "indices.unfreeze" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "indices.unfreeze" }, "responseMediaType": [ "application/json" ], "urls": [ { "deprecation": { "description": "Frozen indices are deprecated because they provide no benefit given improvements in heap memory utilization. They will be removed in a future release.", "version": "7.14.0" }, "methods": [ "POST" ], "path": "/{index}/_unfreeze" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "1.3.0", "stability": "stable" } }, "description": "Create or update an alias.\nAdds a data stream or index to an alias.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.update_aliases", "request": { "name": "Request", "namespace": "indices.update_aliases" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.update_aliases" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_aliases" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "1.3.0", "stability": "stable" } }, "description": "Validate a query.\nValidates a query without running it.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html", "name": "indices.validate_query", "request": { "name": "Request", "namespace": "indices.validate_query" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "indices.validate_query" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_validate/query" }, { "methods": [ "GET", "POST" ], "path": "/{index}/_validate/query" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.11.0", "stability": "stable", "visibility": "public" } }, "description": "Delete an inference endpoint", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html", "name": "inference.delete", "request": { "name": "Request", "namespace": "inference.delete" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "inference.delete" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_inference/{inference_id}" }, { "methods": [ "DELETE" ], "path": "/_inference/{task_type}/{inference_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.11.0", "stability": "stable", "visibility": "public" } }, "description": "Get an inference endpoint", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html", "name": "inference.get", "request": { "name": "Request", "namespace": "inference.get" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "inference.get" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_inference" }, { "methods": [ "GET" ], "path": "/_inference/{inference_id}" }, { "methods": [ "GET" ], "path": "/_inference/{task_type}/{inference_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.11.0", "stability": "stable", "visibility": "public" } }, "description": "Perform inference on the service", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html", "name": "inference.inference", "request": { "name": "Request", "namespace": "inference.inference" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "inference.inference" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_inference/{inference_id}" }, { "methods": [ "POST" ], "path": "/_inference/{task_type}/{inference_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.11.0", "stability": "stable", "visibility": "public" } }, "description": "Create an inference endpoint", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html", "name": "inference.put", "request": { "name": "Request", "namespace": "inference.put" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "inference.put" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_inference/{inference_id}" }, { "methods": [ "PUT" ], "path": "/_inference/{task_type}/{inference_id}" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Perform streaming inference", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-stream-inference-api.html", "name": "inference.stream_inference", "request": null, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "text/event-stream" ], "urls": [ { "methods": [ "POST" ], "path": "/_inference/{inference_id}/_stream" }, { "methods": [ "POST" ], "path": "/_inference/{task_type}/{inference_id}/_stream" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get cluster info.\nReturns basic information about the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "name": "info", "request": { "name": "Request", "namespace": "_global.info" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.info" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/" } ] }, { "availability": { "serverless": { "visibility": "private" }, "stack": { "since": "8.15.0", "stability": "stable" } }, "description": "Delete GeoIP database configurations.\nDelete one or more IP geolocation database configurations.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-geoip-database-api.html", "name": "ingest.delete_geoip_database", "request": { "name": "Request", "namespace": "ingest.delete_geoip_database" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ingest.delete_geoip_database" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ingest/geoip/database/{id}" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Deletes an ip location database configuration", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-ip-location-database-api.html", "name": "ingest.delete_ip_location_database", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ingest/ip_location/database/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.0.0", "stability": "stable" } }, "description": "Delete pipelines.\nDelete one or more ingest pipelines.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html", "extDocId": "ingest", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.delete_pipeline", "request": { "name": "Request", "namespace": "ingest.delete_pipeline" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ingest.delete_pipeline" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ingest/pipeline/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.13.0", "stability": "stable" } }, "description": "Get GeoIP statistics.\nGet download statistics for GeoIP2 databases that are used with the GeoIP processor.", "docId": "geoip-processor", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-processor.html", "extDocId": "geoip-processor", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-processor.html", "name": "ingest.geo_ip_stats", "request": { "name": "Request", "namespace": "ingest.geo_ip_stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ingest.geo_ip_stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ingest/geoip/stats" } ] }, { "availability": { "serverless": { "visibility": "private" }, "stack": { "since": "8.15.0", "stability": "stable" } }, "description": "Get GeoIP database configurations.\nGet information about one or more IP geolocation database configurations.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-geoip-database-api.html", "name": "ingest.get_geoip_database", "request": { "name": "Request", "namespace": "ingest.get_geoip_database" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ingest.get_geoip_database" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ingest/geoip/database" }, { "methods": [ "GET" ], "path": "/_ingest/geoip/database/{id}" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Returns the specified ip location database configuration", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-ip-location-database-api.html", "name": "ingest.get_ip_location_database", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ingest/ip_location/database" }, { "methods": [ "GET" ], "path": "/_ingest/ip_location/database/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.0.0", "stability": "stable" } }, "description": "Get pipelines.\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html", "extDocId": "ingest", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.get_pipeline", "request": { "name": "Request", "namespace": "ingest.get_pipeline" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ingest.get_pipeline" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ingest/pipeline" }, { "methods": [ "GET" ], "path": "/_ingest/pipeline/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.1.0", "stability": "stable" } }, "description": "Run a grok processor.\nExtract structured fields out of a single text field within a document.\nYou must choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "docId": "grok-processor", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html", "extDocId": "grok-processor", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html", "name": "ingest.processor_grok", "request": { "name": "Request", "namespace": "ingest.processor_grok" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ingest.processor_grok" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ingest/processor/grok" } ] }, { "availability": { "serverless": { "visibility": "private" }, "stack": { "since": "8.15.0", "stability": "stable" } }, "description": "Create or update GeoIP database configurations.\nCreate or update IP geolocation database configurations.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-geoip-database-api.html", "name": "ingest.put_geoip_database", "request": { "name": "Request", "namespace": "ingest.put_geoip_database" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ingest.put_geoip_database" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_ingest/geoip/database/{id}" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Puts the configuration for a ip location database to be downloaded", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-ip-location-database-api.html", "name": "ingest.put_ip_location_database", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_ingest/ip_location/database/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.0.0", "stability": "stable" } }, "description": "Create or update a pipeline.\nChanges made using this API take effect immediately.", "docId": "ingest", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "extDocId": "ingest", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.put_pipeline", "request": { "name": "Request", "namespace": "ingest.put_pipeline" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ingest.put_pipeline" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_ingest/pipeline/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.0.0", "stability": "stable" } }, "description": "Simulate a pipeline.\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html", "name": "ingest.simulate", "request": { "name": "Request", "namespace": "ingest.simulate" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ingest.simulate" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_ingest/pipeline/_simulate" }, { "methods": [ "GET", "POST" ], "path": "/_ingest/pipeline/{id}/_simulate" } ] }, { "availability": { "stack": { "since": "8.0.0", "stability": "experimental" } }, "deprecation": { "description": "The kNN search API has been replaced by the `knn` option in the search API.", "version": "8.4.0" }, "description": "Run a knn search.\n\nNOTE: The kNN search API has been replaced by the `knn` option in the search API.\n\nPerform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents.\nGiven a query vector, the API finds the k closest vectors and returns those documents as search hits.\n\nElasticsearch uses the HNSW algorithm to support efficient kNN search.\nLike most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed.\nThis means the results returned are not always the true k closest neighbors.\n\nThe kNN search API supports restricting the search using a filter.\nThe search will return the top k documents that also match the filter query.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", "name": "knn_search", "request": { "name": "Request", "namespace": "_global.knn_search" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.knn_search" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/{index}/_knn_search" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Deletes licensing information for the cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html", "name": "license.delete", "request": { "name": "Request", "namespace": "license.delete" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "license.delete" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_license" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get license information.\nReturns information about your Elastic license, including its type, its status, when it was issued, and when it expires.\nFor more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html", "name": "license.get", "request": { "name": "Request", "namespace": "license.get" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "license.get" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_license" } ] }, { "availability": { "stack": { "since": "6.3.0", "stability": "stable" } }, "description": "Retrieves information about the status of the basic license.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html", "name": "license.get_basic_status", "request": { "name": "Request", "namespace": "license.get_basic_status" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "license.get_basic_status" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_license/basic_status" } ] }, { "availability": { "stack": { "since": "6.1.0", "stability": "stable" } }, "description": "Retrieves information about the status of the trial license.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html", "name": "license.get_trial_status", "request": { "name": "Request", "namespace": "license.get_trial_status" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "license.get_trial_status" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_license/trial_status" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Updates the license for the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html", "name": "license.post", "privileges": { "cluster": [ "manage" ] }, "request": { "name": "Request", "namespace": "license.post" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "license.post" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_license" } ] }, { "availability": { "stack": { "since": "6.3.0", "stability": "stable" } }, "description": "The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.\nTo check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html).", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html", "name": "license.post_start_basic", "request": { "name": "Request", "namespace": "license.post_start_basic" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "license.post_start_basic" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_license/start_basic" } ] }, { "availability": { "stack": { "since": "6.1.0", "stability": "stable" } }, "description": "The start trial API enables you to start a 30-day trial, which gives access to all subscription features.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html", "name": "license.post_start_trial", "privileges": { "cluster": [ "manage" ] }, "request": { "name": "Request", "namespace": "license.post_start_trial" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "license.post_start_trial" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_license/start_trial" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.12.0", "stability": "stable" } }, "description": "Deletes a pipeline used for Logstash Central Management.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html", "name": "logstash.delete_pipeline", "privileges": { "cluster": [ "manage_logstash_pipelines" ] }, "request": { "name": "Request", "namespace": "logstash.delete_pipeline" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "logstash.delete_pipeline" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_logstash/pipeline/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.12.0", "stability": "stable" } }, "description": "Retrieves pipelines used for Logstash Central Management.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html", "name": "logstash.get_pipeline", "privileges": { "cluster": [ "manage_logstash_pipelines" ] }, "request": { "name": "Request", "namespace": "logstash.get_pipeline" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "logstash.get_pipeline" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_logstash/pipeline" }, { "methods": [ "GET" ], "path": "/_logstash/pipeline/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.12.0", "stability": "stable" } }, "description": "Creates or updates a pipeline used for Logstash Central Management.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html", "name": "logstash.put_pipeline", "privileges": { "cluster": [ "manage_logstash_pipelines" ] }, "request": { "name": "Request", "namespace": "logstash.put_pipeline" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "logstash.put_pipeline" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_logstash/pipeline/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "1.3.0", "stability": "stable" } }, "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html", "name": "mget", "privileges": { "index": [ "read" ] }, "request": { "name": "Request", "namespace": "_global.mget" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.mget" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_mget" }, { "methods": [ "GET", "POST" ], "path": "/{index}/_mget" } ] }, { "availability": { "stack": { "since": "6.1.0", "stability": "stable" } }, "description": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html", "name": "migration.deprecations", "request": { "name": "Request", "namespace": "migration.deprecations" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "migration.deprecations" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_migration/deprecations" }, { "methods": [ "GET" ], "path": "/{index}/_migration/deprecations" } ] }, { "availability": { "stack": { "since": "7.16.0", "stability": "stable" } }, "description": "Find out whether system features need to be upgraded or not", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", "name": "migration.get_feature_upgrade_status", "privileges": { "index": [ "manage" ] }, "request": { "name": "Request", "namespace": "migration.get_feature_upgrade_status" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "migration.get_feature_upgrade_status" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_migration/system_features" } ] }, { "availability": { "stack": { "since": "7.16.0", "stability": "stable" } }, "description": "Begin upgrades for system features", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", "name": "migration.post_feature_upgrade", "privileges": { "index": [ "manage" ] }, "request": { "name": "Request", "namespace": "migration.post_feature_upgrade" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "migration.post_feature_upgrade" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_migration/system_features" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.5.0", "stability": "stable" } }, "description": "Clear trained model deployment cache.\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-trained-model-deployment-cache.html", "name": "ml.clear_trained_model_deployment_cache", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.clear_trained_model_deployment_cache" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.clear_trained_model_deployment_cache" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/trained_models/{model_id}/deployment/cache/_clear" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Close anomaly detection jobs.\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", "docId": "ml-close-job", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-close-job.html", "name": "ml.close_job", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.close_job" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.close_job" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/_close" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.2.0", "stability": "stable" } }, "description": "Delete a calendar.\nRemoves all scheduled events from a calendar, then deletes it.", "docId": "ml-delete-calendar", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar.html", "name": "ml.delete_calendar", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.delete_calendar" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.delete_calendar" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ml/calendars/{calendar_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.2.0", "stability": "stable" } }, "description": "Delete events from a calendar.", "docId": "ml-delete-calendar-event", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-event.html", "name": "ml.delete_calendar_event", "request": { "name": "Request", "namespace": "ml.delete_calendar_event" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.delete_calendar_event" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ml/calendars/{calendar_id}/events/{event_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.2.0", "stability": "stable" } }, "description": "Delete anomaly jobs from a calendar.", "docId": "ml-delete-calendar-job", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-job.html", "name": "ml.delete_calendar_job", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.delete_calendar_job" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.delete_calendar_job" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ml/calendars/{calendar_id}/jobs/{job_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.3.0", "stability": "stable" } }, "description": "Delete a data frame analytics job.", "docId": "ml-delete-dfanalytics", "docTag": "ml data frame", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-dfanalytics.html", "name": "ml.delete_data_frame_analytics", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.delete_data_frame_analytics" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.delete_data_frame_analytics" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ml/data_frame/analytics/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Delete a datafeed.", "docId": "ml-delete-datafeed", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-datafeed.html", "name": "ml.delete_datafeed", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.delete_datafeed" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.delete_datafeed" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ml/datafeeds/{datafeed_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Delete expired ML data.\nDeletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html", "name": "ml.delete_expired_data", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.delete_expired_data" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.delete_expired_data" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ml/_delete_expired_data/{job_id}" }, { "methods": [ "DELETE" ], "path": "/_ml/_delete_expired_data" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Delete a filter.\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html", "name": "ml.delete_filter", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.delete_filter" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.delete_filter" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ml/filters/{filter_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "6.5.0", "stability": "stable" } }, "description": "Delete forecasts from a job.\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html", "name": "ml.delete_forecast", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.delete_forecast" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.delete_forecast" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ml/anomaly_detectors/{job_id}/_forecast" }, { "methods": [ "DELETE" ], "path": "/_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Delete an anomaly detection job.\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html", "name": "ml.delete_job", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.delete_job" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.delete_job" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ml/anomaly_detectors/{job_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Delete a model snapshot.\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html", "name": "ml.delete_model_snapshot", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.delete_model_snapshot" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.delete_model_snapshot" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.10.0", "stability": "stable" } }, "description": "Delete an unreferenced trained model.\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html", "name": "ml.delete_trained_model", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.delete_trained_model" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.delete_trained_model" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ml/trained_models/{model_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.13.0", "stability": "stable" } }, "description": "Delete a trained model alias.\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html", "name": "ml.delete_trained_model_alias", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.delete_trained_model_alias" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.delete_trained_model_alias" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_ml/trained_models/{model_id}/model_aliases/{model_alias}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.7.0", "stability": "stable" } }, "description": "Estimate job model memory usage.\nMakes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html", "name": "ml.estimate_model_memory", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.estimate_model_memory" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.estimate_model_memory" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/anomaly_detectors/_estimate_model_memory" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.3.0", "stability": "stable" } }, "description": "Evaluate data frame analytics.\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", "docTag": "ml data frame", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html", "name": "ml.evaluate_data_frame", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.evaluate_data_frame" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.evaluate_data_frame" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/data_frame/_evaluate" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.3.0", "stability": "stable" } }, "description": "Explain data frame analytics config.\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", "docTag": "ml data frame", "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html", "name": "ml.explain_data_frame_analytics", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.explain_data_frame_analytics" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.explain_data_frame_analytics" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_ml/data_frame/analytics/_explain" }, { "methods": [ "GET", "POST" ], "path": "/_ml/data_frame/analytics/{id}/_explain" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Force buffered data to be processed.\nThe flush jobs API is only applicable when sending data for analysis using\nthe post data API. Depending on the content of the buffer, then it might\nadditionally calculate new results. Both flush and close operations are\nsimilar, however the flush is more efficient if you are expecting to send\nmore data for analysis. When flushing, the job remains open and is available\nto continue analyzing data. A close operation additionally prunes and\npersists the model state to disk and the job must be opened again before\nanalyzing further data.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html", "name": "ml.flush_job", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.flush_job" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.flush_job" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/_flush" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "6.1.0", "stability": "stable" } }, "description": "Predict future behavior of a time series.\n\nForecasts are not supported for jobs that perform population analysis; an\nerror occurs if you try to create a forecast for a job that has an\n`over_field_name` in its configuration. Forcasts predict future behavior\nbased on historical data.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html", "name": "ml.forecast", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.forecast" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.forecast" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/_forecast" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Get anomaly detection job results for buckets.\nThe API presents a chronological view of the records, grouped by bucket.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html", "name": "ml.get_buckets", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_buckets" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.get_buckets" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}" }, { "methods": [ "GET", "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/results/buckets" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.2.0", "stability": "stable" } }, "description": "Get info about events in calendars.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html", "name": "ml.get_calendar_events", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_calendar_events" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.get_calendar_events" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ml/calendars/{calendar_id}/events" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.2.0", "stability": "stable" } }, "description": "Get calendar configuration info.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html", "name": "ml.get_calendars", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_calendars" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.get_calendars" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_ml/calendars" }, { "methods": [ "GET", "POST" ], "path": "/_ml/calendars/{calendar_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Get anomaly detection job results for categories.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html", "name": "ml.get_categories", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_categories" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.get_categories" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/results/categories/{category_id}" }, { "methods": [ "GET", "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/results/categories" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.3.0", "stability": "stable" } }, "description": "Get data frame analytics job configuration info.\nYou can get information for multiple data frame analytics jobs in a single\nAPI request by using a comma-separated list of data frame analytics jobs or a\nwildcard expression.", "docTag": "ml data frame", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html", "name": "ml.get_data_frame_analytics", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_data_frame_analytics" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.get_data_frame_analytics" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ml/data_frame/analytics/{id}" }, { "methods": [ "GET" ], "path": "/_ml/data_frame/analytics" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.3.0", "stability": "stable" } }, "description": "Get data frame analytics jobs usage info.", "docTag": "ml data frame", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html", "name": "ml.get_data_frame_analytics_stats", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_data_frame_analytics_stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.get_data_frame_analytics_stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ml/data_frame/analytics/_stats" }, { "methods": [ "GET" ], "path": "/_ml/data_frame/analytics/{id}/_stats" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.5.0", "stability": "stable" } }, "description": "Get datafeeds usage info.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html", "name": "ml.get_datafeed_stats", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_datafeed_stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.get_datafeed_stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ml/datafeeds/{datafeed_id}/_stats" }, { "methods": [ "GET" ], "path": "/_ml/datafeeds/_stats" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.5.0", "stability": "stable" } }, "description": "Get datafeeds configuration info.\nYou can get information for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget information for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html", "name": "ml.get_datafeeds", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_datafeeds" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.get_datafeeds" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ml/datafeeds/{datafeed_id}" }, { "methods": [ "GET" ], "path": "/_ml/datafeeds" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.5.0", "stability": "stable" } }, "description": "Get filters.\nYou can get a single filter or all filters.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html", "name": "ml.get_filters", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_filters" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.get_filters" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ml/filters" }, { "methods": [ "GET" ], "path": "/_ml/filters/{filter_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Get anomaly detection job results for influencers.\nInfluencers are the entities that have contributed to, or are to blame for,\nthe anomalies. Influencer results are available only if an\n`influencer_field_name` is specified in the job configuration.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html", "name": "ml.get_influencers", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_influencers" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.get_influencers" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/results/influencers" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.5.0", "stability": "stable" } }, "description": "Get anomaly detection jobs usage info.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html", "name": "ml.get_job_stats", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_job_stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.get_job_stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ml/anomaly_detectors/_stats" }, { "methods": [ "GET" ], "path": "/_ml/anomaly_detectors/{job_id}/_stats" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.5.0", "stability": "stable" } }, "description": "Get anomaly detection jobs configuration info.\nYou can get information for multiple anomaly detection jobs in a single API\nrequest by using a group name, a comma-separated list of jobs, or a wildcard\nexpression. You can get information for all anomaly detection jobs by using\n`_all`, by specifying `*` as the ``, or by omitting the ``.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html", "name": "ml.get_jobs", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_jobs" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.get_jobs" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ml/anomaly_detectors/{job_id}" }, { "methods": [ "GET" ], "path": "/_ml/anomaly_detectors" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.2.0", "stability": "stable" } }, "description": "Get machine learning memory usage info.\nGet information about how machine learning jobs and trained models are using memory,\non each node, both within the JVM heap, and natively, outside of the JVM.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html", "name": "ml.get_memory_stats", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_memory_stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.get_memory_stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ml/memory/_stats" }, { "methods": [ "GET" ], "path": "/_ml/memory/{node_id}/_stats" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.16.0", "stability": "stable" } }, "description": "Get anomaly detection job model snapshot upgrade usage info.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html", "name": "ml.get_model_snapshot_upgrade_stats", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_model_snapshot_upgrade_stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.get_model_snapshot_upgrade_stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Get model snapshots info.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html", "name": "ml.get_model_snapshots", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_model_snapshots" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.get_model_snapshots" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}" }, { "methods": [ "GET", "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.1.0", "stability": "stable" } }, "description": "Get overall bucket results.\n\nRetrievs overall bucket results that summarize the bucket results of\nmultiple anomaly detection jobs.\n\nThe `overall_score` is calculated by combining the scores of all the\nbuckets within the overall bucket span. First, the maximum\n`anomaly_score` per anomaly detection job in the overall bucket is\ncalculated. Then the `top_n` of those scores are averaged to result in\nthe `overall_score`. This means that you can fine-tune the\n`overall_score` so that it is more or less sensitive to the number of\njobs that detect an anomaly at the same time. For example, if you set\n`top_n` to `1`, the `overall_score` is the maximum bucket score in the\noverall bucket. Alternatively, if you set `top_n` to the number of jobs,\nthe `overall_score` is high only when all jobs detect anomalies in that\noverall bucket. If you set the `bucket_span` parameter (to a value\ngreater than its default), the `overall_score` is the maximum\n`overall_score` of the overall buckets that have a span equal to the\njobs' largest bucket span.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html", "name": "ml.get_overall_buckets", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_overall_buckets" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.get_overall_buckets" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/results/overall_buckets" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Get anomaly records for an anomaly detection job.\nRecords contain the detailed analytical results. They describe the anomalous\nactivity that has been identified in the input data based on the detector\nconfiguration.\nThere can be many anomaly records depending on the characteristics and size\nof the input data. In practice, there are often too many to be able to\nmanually process them. The machine learning features therefore perform a\nsophisticated aggregation of the anomaly records into buckets.\nThe number of record results depends on the number of anomalies found in each\nbucket, which relates to the number of time series being modeled and the\nnumber of detectors.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html", "name": "ml.get_records", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_records" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.get_records" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/results/records" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.10.0", "stability": "stable" } }, "description": "Get trained model configuration info.", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html", "name": "ml.get_trained_models", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_trained_models" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.get_trained_models" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ml/trained_models/{model_id}" }, { "methods": [ "GET" ], "path": "/_ml/trained_models" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.10.0", "stability": "stable" } }, "description": "Get trained models usage info.\nYou can get usage information for multiple trained\nmodels in a single API request by using a comma-separated list of model IDs or a wildcard expression.", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html", "name": "ml.get_trained_models_stats", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.get_trained_models_stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.get_trained_models_stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ml/trained_models/{model_id}/_stats" }, { "methods": [ "GET" ], "path": "/_ml/trained_models/_stats" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.3.0", "stability": "stable" } }, "description": "Evaluate a trained model.", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html", "name": "ml.infer_trained_model", "request": { "name": "Request", "namespace": "ml.infer_trained_model" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.infer_trained_model" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/trained_models/{model_id}/_infer" }, { "deprecation": { "description": "/_ml/trained_models/{model_id}/deployment/_infer is deprecated. Use /_ml/trained_models/{model_id}/_infer instead", "version": "8.3.0" }, "methods": [ "POST" ], "path": "/_ml/trained_models/{model_id}/deployment/_infer" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "6.3.0", "stability": "stable" } }, "description": "Return ML defaults and limits.\nReturns defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html", "name": "ml.info", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.info" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.info" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ml/info" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Open anomaly detection jobs.\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html", "name": "ml.open_job", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.open_job" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.open_job" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/_open" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.2.0", "stability": "stable" } }, "description": "Add scheduled events to the calendar.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html", "name": "ml.post_calendar_events", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.post_calendar_events" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.post_calendar_events" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/calendars/{calendar_id}/events" } ] }, { "availability": { "stack": { "since": "5.4.0", "stability": "stable" } }, "deprecation": { "description": "Posting data directly to anomaly detection jobs is deprecated, in a future major version a datafeed will be required.", "version": "7.11.0" }, "description": "Send data to an anomaly detection job for analysis.\n\nIMPORTANT: For each job, data can be accepted from only a single connection at a time.\nIt is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html", "name": "ml.post_data", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.post_data" }, "requestBodyRequired": true, "requestMediaType": [ "application/x-ndjson", "application/json" ], "response": { "name": "Response", "namespace": "ml.post_data" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/_data" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.13.0", "stability": "stable" } }, "description": "Preview features used by data frame analytics.\nPreviews the extracted features used by a data frame analytics config.", "docTag": "ml data frame", "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html", "name": "ml.preview_data_frame_analytics", "privileges": { "cluster": [ "monitor_ml" ] }, "request": { "name": "Request", "namespace": "ml.preview_data_frame_analytics" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.preview_data_frame_analytics" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_ml/data_frame/analytics/_preview" }, { "methods": [ "GET", "POST" ], "path": "/_ml/data_frame/analytics/{id}/_preview" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Preview a datafeed.\nThis API returns the first \"page\" of search results from a datafeed.\nYou can preview an existing datafeed or provide configuration details for a datafeed\nand anomaly detection job in the API. The preview shows the structure of the data\nthat will be passed to the anomaly detection engine.\nIMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that\ncalled the API. However, when the datafeed starts it uses the roles of the last user that created or updated the\ndatafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.\nYou can also use secondary authorization headers to supply the credentials.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html", "name": "ml.preview_datafeed", "privileges": { "cluster": [ "manage_ml" ], "index": [ "read" ] }, "request": { "name": "Request", "namespace": "ml.preview_datafeed" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.preview_datafeed" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_ml/datafeeds/{datafeed_id}/_preview" }, { "methods": [ "GET", "POST" ], "path": "/_ml/datafeeds/_preview" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.2.0", "stability": "stable" } }, "description": "Create a calendar.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html", "name": "ml.put_calendar", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.put_calendar" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.put_calendar" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_ml/calendars/{calendar_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.2.0", "stability": "stable" } }, "description": "Add anomaly detection job to calendar.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html", "name": "ml.put_calendar_job", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.put_calendar_job" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.put_calendar_job" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_ml/calendars/{calendar_id}/jobs/{job_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.3.0", "stability": "stable" } }, "description": "Create a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", "docId": "put-dfanalytics", "docTag": "ml data frame", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-dfanalytics.html", "name": "ml.put_data_frame_analytics", "privileges": { "cluster": [ "manage_ml" ], "index": [ "create_index", "index", "manage", "read", "view_index_metadata" ] }, "request": { "name": "Request", "namespace": "ml.put_data_frame_analytics" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.put_data_frame_analytics" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_ml/data_frame/analytics/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Create a datafeed.\nDatafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.\nYou can associate only one datafeed with each anomaly detection job.\nThe datafeed contains a query that runs at a defined interval (`frequency`).\nIf you are concerned about delayed data, you can add a delay (`query_delay`) at each interval.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had\nat the time of creation and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\nYou must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed\ndirectly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html", "name": "ml.put_datafeed", "privileges": { "cluster": [ "manage_ml" ], "index": [ "read" ] }, "request": { "name": "Request", "namespace": "ml.put_datafeed" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.put_datafeed" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_ml/datafeeds/{datafeed_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Create a filter.\nA filter contains a list of strings. It can be used by one or more anomaly detection jobs.\nSpecifically, filters are referenced in the `custom_rules` property of detector configuration objects.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html", "name": "ml.put_filter", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.put_filter" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.put_filter" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_ml/filters/{filter_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Create an anomaly detection job.\nIf you include a `datafeed_config`, you must have read index privileges on the source index.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html", "name": "ml.put_job", "privileges": { "cluster": [ "manage_ml" ], "index": [ "read" ] }, "request": { "name": "Request", "namespace": "ml.put_job" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.put_job" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_ml/anomaly_detectors/{job_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.10.0", "stability": "stable" } }, "description": "Create a trained model.\nEnable you to supply a trained model that is not created by data frame analytics.", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html", "name": "ml.put_trained_model", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.put_trained_model" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.put_trained_model" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_ml/trained_models/{model_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.13.0", "stability": "stable" } }, "description": "Create or update a trained model alias.\nA trained model alias is a logical name used to reference a single trained\nmodel.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html", "name": "ml.put_trained_model_alias", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.put_trained_model_alias" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.put_trained_model_alias" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_ml/trained_models/{model_id}/model_aliases/{model_alias}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.0.0", "stability": "stable" } }, "description": "Create part of a trained model definition.", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html", "name": "ml.put_trained_model_definition_part", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.put_trained_model_definition_part" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.put_trained_model_definition_part" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_ml/trained_models/{model_id}/definition/{part}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.0.0", "stability": "stable" } }, "description": "Create a trained model vocabulary.\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html", "name": "ml.put_trained_model_vocabulary", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.put_trained_model_vocabulary" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.put_trained_model_vocabulary" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_ml/trained_models/{model_id}/vocabulary" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.14.0", "stability": "stable" } }, "description": "Reset an anomaly detection job.\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html", "name": "ml.reset_job", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.reset_job" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.reset_job" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/_reset" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Revert to a snapshot.\nThe machine learning features react quickly to anomalous input, learning new\nbehaviors in data. Highly anomalous input increases the variance in the\nmodels whilst the system learns whether this is a new step-change in behavior\nor a one-off event. In the case where this anomalous input is known to be a\none-off, then it might be appropriate to reset the model state to a time\nbefore this event. For example, you might consider reverting to a saved\nsnapshot after Black Friday or a critical system failure.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html", "name": "ml.revert_model_snapshot", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.revert_model_snapshot" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.revert_model_snapshot" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "6.7.0", "stability": "stable" } }, "description": "Set upgrade_mode for ML indices.\nSets a cluster wide upgrade_mode setting that prepares machine learning\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html", "name": "ml.set_upgrade_mode", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.set_upgrade_mode" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.set_upgrade_mode" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/set_upgrade_mode" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.3.0", "stability": "stable" } }, "description": "Start a data frame analytics job.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", "docTag": "ml data frame", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html", "name": "ml.start_data_frame_analytics", "privileges": { "cluster": [ "manage_ml" ], "index": [ "create_index", "index", "manage", "read", "view_index_metadata" ] }, "request": { "name": "Request", "namespace": "ml.start_data_frame_analytics" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.start_data_frame_analytics" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/data_frame/analytics/{id}/_start" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.5.0", "stability": "stable" } }, "description": "Start datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html", "name": "ml.start_datafeed", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.start_datafeed" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.start_datafeed" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/datafeeds/{datafeed_id}/_start" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.0.0", "stability": "stable" } }, "description": "Start a trained model deployment.\nIt allocates the model to every machine learning node.", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html", "name": "ml.start_trained_model_deployment", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.start_trained_model_deployment" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.start_trained_model_deployment" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/trained_models/{model_id}/deployment/_start" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.3.0", "stability": "stable" } }, "description": "Stop data frame analytics jobs.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", "docTag": "ml data frame", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html", "name": "ml.stop_data_frame_analytics", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.stop_data_frame_analytics" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.stop_data_frame_analytics" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/data_frame/analytics/{id}/_stop" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Stop datafeeds.\nA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html", "name": "ml.stop_datafeed", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.stop_datafeed" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.stop_datafeed" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/datafeeds/{datafeed_id}/_stop" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.0.0", "stability": "stable" } }, "description": "Stop a trained model deployment.", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html", "name": "ml.stop_trained_model_deployment", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.stop_trained_model_deployment" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.stop_trained_model_deployment" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/trained_models/{model_id}/deployment/_stop" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.3.0", "stability": "stable" } }, "description": "Update a data frame analytics job.", "docTag": "ml data frame", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html", "name": "ml.update_data_frame_analytics", "privileges": { "cluster": [ "manage_ml" ], "index": [ "read", "create_index", "manage", "index", "view_index_metadata" ] }, "request": { "name": "Request", "namespace": "ml.update_data_frame_analytics" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.update_data_frame_analytics" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/data_frame/analytics/{id}/_update" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.4.0", "stability": "stable" } }, "description": "Update a datafeed.\nYou must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html", "name": "ml.update_datafeed", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.update_datafeed" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.update_datafeed" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/datafeeds/{datafeed_id}/_update" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.4.0", "stability": "stable" } }, "description": "Update a filter.\nUpdates the description of a filter, adds items, or removes items from the list.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html", "name": "ml.update_filter", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.update_filter" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.update_filter" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/filters/{filter_id}/_update" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.5.0", "stability": "stable" } }, "description": "Update an anomaly detection job.\nUpdates certain properties of an anomaly detection job.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html", "name": "ml.update_job", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.update_job" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.update_job" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/_update" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Update a snapshot.\nUpdates certain properties of a snapshot.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html", "name": "ml.update_model_snapshot", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.update_model_snapshot" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.update_model_snapshot" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.6.0", "stability": "stable" } }, "description": "Update a trained model deployment.", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html", "name": "ml.update_trained_model_deployment", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.update_trained_model_deployment" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.update_trained_model_deployment" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/trained_models/{model_id}/deployment/_update" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.4.0", "stability": "stable" } }, "description": "Upgrade a snapshot.\nUpgrades an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html", "name": "ml.upgrade_job_snapshot", "privileges": { "cluster": [ "manage_ml" ] }, "request": { "name": "Request", "namespace": "ml.upgrade_job_snapshot" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ml.upgrade_job_snapshot" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "6.3.0", "stability": "stable", "visibility": "private" } }, "description": "Validates an anomaly detection job.", "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", "name": "ml.validate", "request": { "name": "Request", "namespace": "ml.validate" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.validate" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/anomaly_detectors/_validate" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.4.0", "stability": "stable", "visibility": "private" } }, "description": "Validates an anomaly detection detector.", "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", "name": "ml.validate_detector", "request": { "name": "Request", "namespace": "ml.validate_detector" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "ml.validate_detector" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_ml/anomaly_detectors/_validate/detector" } ] }, { "availability": { "stack": { "since": "6.3.0", "stability": "stable" } }, "description": "Used by the monitoring features to send monitoring data.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html", "name": "monitoring.bulk", "request": { "name": "Request", "namespace": "monitoring.bulk" }, "requestBodyRequired": true, "requestMediaType": [ "application/x-ndjson" ], "response": { "name": "Response", "namespace": "monitoring.bulk" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST", "PUT" ], "path": "/_monitoring/bulk" }, { "deprecation": { "description": "Specifying types in urls has been deprecated", "version": "7.0.0" }, "methods": [ "POST", "PUT" ], "path": "/_monitoring/{type}/bulk" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "1.3.0", "stability": "stable" } }, "description": "Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html", "name": "msearch", "privileges": { "index": [ "read" ] }, "request": { "name": "Request", "namespace": "_global.msearch" }, "requestBodyRequired": true, "requestMediaType": [ "application/x-ndjson" ], "response": { "name": "Response", "namespace": "_global.msearch" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_msearch" }, { "methods": [ "GET", "POST" ], "path": "/{index}/_msearch" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.0.0", "stability": "stable" } }, "description": "Run multiple templated searches.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html", "extDocId": "search-templates", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template.html", "name": "msearch_template", "privileges": { "index": [ "read" ] }, "request": { "name": "Request", "namespace": "_global.msearch_template" }, "requestBodyRequired": true, "requestMediaType": [ "application/x-ndjson" ], "response": { "name": "Response", "namespace": "_global.msearch_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_msearch/template" }, { "methods": [ "GET", "POST" ], "path": "/{index}/_msearch/template" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get multiple term vectors.\n\nYou can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html", "name": "mtermvectors", "request": { "name": "Request", "namespace": "_global.mtermvectors" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.mtermvectors" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_mtermvectors" }, { "methods": [ "GET", "POST" ], "path": "/{index}/_mtermvectors" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "private" }, "stack": { "since": "7.16.0", "stability": "experimental" } }, "description": "You can use this API to clear the archived repositories metering information in the cluster.", "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html", "name": "nodes.clear_repositories_metering_archive", "privileges": { "cluster": [ "monitor", "manage" ] }, "request": { "name": "Request", "namespace": "nodes.clear_repositories_metering_archive" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "nodes.clear_repositories_metering_archive" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_nodes/{node_id}/_repositories_metering/{max_archive_version}" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "private" }, "stack": { "since": "7.16.0", "stability": "experimental" } }, "description": "You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.\nThis API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the\ninformation needed to compute aggregations over a period of time. Additionally, the information exposed by this\nAPI is volatile, meaning that it won’t be present after node restarts.", "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html", "name": "nodes.get_repositories_metering_info", "privileges": { "cluster": [ "monitor", "manage" ] }, "request": { "name": "Request", "namespace": "nodes.get_repositories_metering_info" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "nodes.get_repositories_metering_info" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_nodes/{node_id}/_repositories_metering" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "This API yields a breakdown of the hot threads on each selected node in the cluster.\nThe output is plain text with a breakdown of each node’s top hot threads.", "docId": "cluster-nodes-hot-threads", "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-hot-threads.html", "name": "nodes.hot_threads", "privileges": { "cluster": [ "monitor", "manage" ] }, "request": { "name": "Request", "namespace": "nodes.hot_threads" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "nodes.hot_threads" }, "responseMediaType": [ "text/plain" ], "urls": [ { "methods": [ "GET" ], "path": "/_nodes/hot_threads" }, { "methods": [ "GET" ], "path": "/_nodes/{node_id}/hot_threads" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "1.3.0", "stability": "stable" } }, "description": "Returns cluster nodes information.", "docId": "cluster-nodes-info", "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-info.html", "name": "nodes.info", "request": { "name": "Request", "namespace": "nodes.info" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "nodes.info" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_nodes" }, { "methods": [ "GET" ], "path": "/_nodes/{node_id}" }, { "methods": [ "GET" ], "path": "/_nodes/{metric}" }, { "methods": [ "GET" ], "path": "/_nodes/{node_id}/{metric}" } ] }, { "availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "description": "Reloads the keystore on nodes in the cluster.", "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings", "name": "nodes.reload_secure_settings", "request": { "name": "Request", "namespace": "nodes.reload_secure_settings" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "nodes.reload_secure_settings" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_nodes/reload_secure_settings" }, { "methods": [ "POST" ], "path": "/_nodes/{node_id}/reload_secure_settings" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Returns cluster nodes statistics.", "docId": "cluster-nodes-stats", "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-stats.html", "name": "nodes.stats", "privileges": { "cluster": [ "monitor", "manage" ] }, "request": { "name": "Request", "namespace": "nodes.stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "nodes.stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_nodes/stats" }, { "methods": [ "GET" ], "path": "/_nodes/{node_id}/stats" }, { "methods": [ "GET" ], "path": "/_nodes/stats/{metric}" }, { "methods": [ "GET" ], "path": "/_nodes/{node_id}/stats/{metric}" }, { "methods": [ "GET" ], "path": "/_nodes/stats/{metric}/{index_metric}" }, { "methods": [ "GET" ], "path": "/_nodes/{node_id}/stats/{metric}/{index_metric}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "6.0.0", "stability": "stable" } }, "description": "Returns information on the usage of features.", "docId": "cluster-nodes-usage", "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-usage.html", "name": "nodes.usage", "privileges": { "cluster": [ "monitor", "manage" ] }, "request": { "name": "Request", "namespace": "nodes.usage" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "nodes.usage" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_nodes/usage" }, { "methods": [ "GET" ], "path": "/_nodes/{node_id}/usage" }, { "methods": [ "GET" ], "path": "/_nodes/usage/{metric}" }, { "methods": [ "GET" ], "path": "/_nodes/{node_id}/usage/{metric}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.10.0", "stability": "stable" } }, "description": "Open a point in time.\n\nA search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.", "docId": "point-in-time-api", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html", "name": "open_point_in_time", "privileges": { "index": [ "read" ] }, "request": { "name": "Request", "namespace": "_global.open_point_in_time" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.open_point_in_time" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/{index}/_pit" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Ping the cluster.\nReturns whether the cluster is running.", "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "name": "ping", "request": { "name": "Request", "namespace": "_global.ping" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.ping" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "HEAD" ], "path": "/" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "private" } }, "description": "Extracts a UI-optimized structure to render flamegraphs from Universal Profiling.", "docUrl": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", "name": "profiling.flamegraph", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_profiling/flamegraph" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "private" } }, "description": "Extracts raw stacktrace information from Universal Profiling.", "docUrl": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", "name": "profiling.stacktraces", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_profiling/stacktraces" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "private" } }, "description": "Returns basic information about the status of Universal Profiling.", "docUrl": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", "name": "profiling.status", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_profiling/status" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "private" } }, "description": "Extracts a list of topN functions from Universal Profiling.", "docUrl": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", "name": "profiling.topn_functions", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_profiling/topn/functions" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Create or update a script or search template.\nCreates or updates a stored script or search template.", "docTag": "script", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "put_script", "request": { "name": "Request", "namespace": "_global.put_script" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.put_script" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_scripts/{id}" }, { "methods": [ "PUT", "POST" ], "path": "/_scripts/{id}/{context}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.15.0", "stability": "stable" } }, "description": "Delete a query rule.\nDelete a query rule within a query ruleset.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-rule.html", "name": "query_rules.delete_rule", "request": { "name": "Request", "namespace": "query_rules.delete_rule" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "query_rules.delete_rule" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_query_rules/{ruleset_id}/_rule/{rule_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", "stability": "stable" } }, "description": "Delete a query ruleset.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-ruleset.html", "name": "query_rules.delete_ruleset", "request": { "name": "Request", "namespace": "query_rules.delete_ruleset" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "query_rules.delete_ruleset" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_query_rules/{ruleset_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.15.0", "stability": "stable" } }, "description": "Get a query rule.\nGet details about a query rule within a query ruleset.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-rule.html", "extDocId": "query-rule", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-using-query-rules.html", "name": "query_rules.get_rule", "request": { "name": "Request", "namespace": "query_rules.get_rule" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "query_rules.get_rule" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_query_rules/{ruleset_id}/_rule/{rule_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", "stability": "stable" } }, "description": "Get a query ruleset.\nGet details about a query ruleset.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-ruleset.html", "name": "query_rules.get_ruleset", "request": { "name": "Request", "namespace": "query_rules.get_ruleset" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "query_rules.get_ruleset" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_query_rules/{ruleset_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", "stability": "stable" } }, "description": "Get all query rulesets.\nGet summarized information about the query rulesets.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-query-rulesets.html", "name": "query_rules.list_rulesets", "request": { "name": "Request", "namespace": "query_rules.list_rulesets" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "query_rules.list_rulesets" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_query_rules" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.15.0", "stability": "stable" } }, "description": "Create or update a query rule.\nCreate or update a query rule within a query ruleset.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-rule.html", "name": "query_rules.put_rule", "request": { "name": "Request", "namespace": "query_rules.put_rule" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "query_rules.put_rule" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_query_rules/{ruleset_id}/_rule/{rule_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", "stability": "stable" } }, "description": "Create or update a query ruleset.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-ruleset.html", "extDocId": "query-rule", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-using-query-rules.html", "name": "query_rules.put_ruleset", "request": { "name": "Request", "namespace": "query_rules.put_ruleset" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "query_rules.put_ruleset" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_query_rules/{ruleset_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", "stability": "stable" } }, "description": "Test a query ruleset.\nEvaluate match criteria against a query ruleset to identify the rules that would match that criteria.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-query-ruleset.html", "name": "query_rules.test", "request": { "name": "Request", "namespace": "query_rules.test" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "query_rules.test" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_query_rules/{ruleset_id}/_test" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.2.0", "stability": "stable" } }, "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html", "name": "rank_eval", "privileges": { "index": [ "read" ] }, "request": { "name": "Request", "namespace": "_global.rank_eval" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.rank_eval" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_rank_eval" }, { "methods": [ "GET", "POST" ], "path": "/{index}/_rank_eval" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "2.3.0", "stability": "stable" } }, "description": "Reindex documents.\nCopies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", "name": "reindex", "request": { "name": "Request", "namespace": "_global.reindex" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.reindex" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_reindex" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "2.4.0", "stability": "stable" } }, "description": "Throttle a reindex operation.\n\nChange the number of requests per second for a particular reindex operation.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", "name": "reindex_rethrottle", "request": { "name": "Request", "namespace": "_global.reindex_rethrottle" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.reindex_rethrottle" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_reindex/{task_id}/_rethrottle" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Render a search template.\n\nRender a search template as a search request body.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html", "name": "render_search_template", "request": { "name": "Request", "namespace": "_global.render_search_template" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.render_search_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_render/template" }, { "methods": [ "GET", "POST" ], "path": "/_render/template/{id}" } ] }, { "availability": { "stack": { "since": "6.3.0", "stability": "experimental" } }, "description": "Deletes an existing rollup job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html", "name": "rollup.delete_job", "request": { "name": "Request", "namespace": "rollup.delete_job" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "rollup.delete_job" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_rollup/job/{id}" } ] }, { "availability": { "stack": { "since": "6.3.0", "stability": "experimental" } }, "description": "Retrieves the configuration, stats, and status of rollup jobs.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html", "name": "rollup.get_jobs", "request": { "name": "Request", "namespace": "rollup.get_jobs" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "rollup.get_jobs" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_rollup/job/{id}" }, { "methods": [ "GET" ], "path": "/_rollup/job" } ] }, { "availability": { "stack": { "since": "6.3.0", "stability": "experimental" } }, "description": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-caps.html", "name": "rollup.get_rollup_caps", "request": { "name": "Request", "namespace": "rollup.get_rollup_caps" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "rollup.get_rollup_caps" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_rollup/data/{id}" }, { "methods": [ "GET" ], "path": "/_rollup/data" } ] }, { "availability": { "stack": { "since": "6.4.0", "stability": "experimental" } }, "description": "Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored).", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-index-caps.html", "name": "rollup.get_rollup_index_caps", "request": { "name": "Request", "namespace": "rollup.get_rollup_index_caps" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "rollup.get_rollup_index_caps" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/{index}/_rollup/data" } ] }, { "availability": { "stack": { "since": "6.3.0", "stability": "experimental" } }, "description": "Creates a rollup job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html", "name": "rollup.put_job", "privileges": { "cluster": [ "manage", "manage_rollup" ] }, "request": { "name": "Request", "namespace": "rollup.put_job" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "rollup.put_job" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_rollup/job/{id}" } ] }, { "availability": { "stack": { "since": "6.3.0", "stability": "experimental" } }, "description": "Enables searching rolled-up data using the standard Query DSL.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html", "name": "rollup.rollup_search", "request": { "name": "Request", "namespace": "rollup.rollup_search" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "rollup.rollup_search" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/{index}/_rollup_search" } ] }, { "availability": { "stack": { "since": "6.3.0", "stability": "experimental" } }, "description": "Starts an existing, stopped rollup job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-start-job.html", "name": "rollup.start_job", "request": { "name": "Request", "namespace": "rollup.start_job" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "rollup.start_job" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_rollup/job/{id}/_start" } ] }, { "availability": { "stack": { "since": "6.3.0", "stability": "experimental" } }, "description": "Stops an existing, started rollup job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-stop-job.html", "name": "rollup.stop_job", "request": { "name": "Request", "namespace": "rollup.stop_job" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "rollup.stop_job" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_rollup/job/{id}/_stop" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "public" }, "stack": { "since": "6.3.0", "stability": "experimental" } }, "description": "Run a script.\nRuns a script and returns a result.", "docTag": "script", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html", "name": "scripts_painless_execute", "request": { "name": "Request", "namespace": "_global.scripts_painless_execute" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.scripts_painless_execute" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_scripts/painless/_execute" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Run a scrolling search.\n\nIMPORTANT: 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 the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll", "extDocId": "scroll-search-results", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results", "name": "scroll", "request": { "name": "Request", "namespace": "_global.scroll" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.scroll" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_search/scroll" }, { "deprecation": { "description": "A scroll id can be quite large and should be specified as part of the body", "version": "7.0.0" }, "methods": [ "GET", "POST" ], "path": "/_search/scroll/{scroll_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Run a search.\n\nGet search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", "name": "search", "privileges": { "index": [ "read" ] }, "request": { "name": "Request", "namespace": "_global.search" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.search" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_search" }, { "methods": [ "GET", "POST" ], "path": "/{index}/_search" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.8.0", "stability": "beta" } }, "description": "Delete a search application.\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html", "name": "search_application.delete", "request": { "name": "Request", "namespace": "search_application.delete" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "search_application.delete" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_application/search_application/{name}" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "public" }, "stack": { "since": "8.8.0", "stability": "experimental" } }, "description": "Delete a behavioral analytics collection.\nThe associated data stream is also deleted.", "docTag": "analytics", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html", "name": "search_application.delete_behavioral_analytics", "request": { "name": "Request", "namespace": "search_application.delete_behavioral_analytics" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "search_application.delete_behavioral_analytics" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_application/analytics/{name}" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.8.0", "stability": "beta" } }, "description": "Get search application details.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html", "name": "search_application.get", "request": { "name": "Request", "namespace": "search_application.get" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "search_application.get" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_application/search_application/{name}" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "public" }, "stack": { "since": "8.8.0", "stability": "experimental" } }, "description": "Get behavioral analytics collections.", "docTag": "analytics", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html", "name": "search_application.get_behavioral_analytics", "request": { "name": "Request", "namespace": "search_application.get_behavioral_analytics" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "search_application.get_behavioral_analytics" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_application/analytics" }, { "methods": [ "GET" ], "path": "/_application/analytics/{name}" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.8.0", "stability": "beta" } }, "description": "Returns the existing search applications.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-search-applications.html", "name": "search_application.list", "request": { "name": "Request", "namespace": "search_application.list" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "search_application.list" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_application/search_application" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "description": "Creates a behavioral analytics event for existing collection.", "docUrl": "http://todo.com/tbd", "name": "search_application.post_behavioral_analytics_event", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_application/analytics/{collection_name}/event/{event_type}" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.8.0", "stability": "beta" } }, "description": "Create or update a search application.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html", "name": "search_application.put", "request": { "name": "Request", "namespace": "search_application.put" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "search_application.put" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_application/search_application/{name}" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "public" }, "stack": { "since": "8.8.0", "stability": "experimental" } }, "description": "Create a behavioral analytics collection.", "docTag": "analytics", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html", "name": "search_application.put_behavioral_analytics", "request": { "name": "Request", "namespace": "search_application.put_behavioral_analytics" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "search_application.put_behavioral_analytics" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_application/analytics/{name}" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "description": "Renders a query for given search application search parameters", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-render-query.html", "name": "search_application.render_query", "request": null, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_application/search_application/{name}/_render_query" } ] }, { "availability": { "serverless": { "stability": "beta", "visibility": "public" }, "stack": { "since": "8.8.0", "stability": "beta" } }, "description": "Run a search application search.\nGenerate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html", "name": "search_application.search", "request": { "name": "Request", "namespace": "search_application.search" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "search_application.search" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_application/search_application/{name}/_search" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.15.0", "stability": "stable" } }, "description": "Search a vector tile.\n\nSearch a vector tile for geospatial values.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html", "name": "search_mvt", "request": { "name": "Request", "namespace": "_global.search_mvt" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.search_mvt" }, "responseMediaType": [ "application/vnd.mapbox-vector-tile" ], "urls": [ { "methods": [ "POST", "GET" ], "path": "/{index}/_mvt/{field}/{zoom}/{x}/{y}" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Get the search shards.\n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the indices section.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html", "name": "search_shards", "request": { "name": "Request", "namespace": "_global.search_shards" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.search_shards" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_search_shards" }, { "methods": [ "GET", "POST" ], "path": "/{index}/_search_shards" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "2.0.0", "stability": "stable" } }, "description": "Run a search with a search template.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", "extDocId": "search-template", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template.html", "name": "search_template", "request": { "name": "Request", "namespace": "_global.search_template" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.search_template" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_search/template" }, { "methods": [ "GET", "POST" ], "path": "/{index}/_search/template" } ] }, { "availability": { "stack": { "since": "7.13.0", "stability": "experimental" } }, "description": "Retrieve node-level cache statistics about searchable snapshots.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "name": "searchable_snapshots.cache_stats", "request": { "name": "Request", "namespace": "searchable_snapshots.cache_stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "searchable_snapshots.cache_stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_searchable_snapshots/cache/stats" }, { "methods": [ "GET" ], "path": "/_searchable_snapshots/{node_id}/cache/stats" } ] }, { "availability": { "stack": { "since": "7.10.0", "stability": "experimental" } }, "description": "Clear the cache of searchable snapshots.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "name": "searchable_snapshots.clear_cache", "request": { "name": "Request", "namespace": "searchable_snapshots.clear_cache" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "searchable_snapshots.clear_cache" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_searchable_snapshots/cache/clear" }, { "methods": [ "POST" ], "path": "/{index}/_searchable_snapshots/cache/clear" } ] }, { "availability": { "stack": { "since": "7.10.0", "stability": "stable" } }, "description": "Mount a snapshot as a searchable index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-api-mount-snapshot.html", "name": "searchable_snapshots.mount", "request": { "name": "Request", "namespace": "searchable_snapshots.mount" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "searchable_snapshots.mount" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_snapshot/{repository}/{snapshot}/_mount" } ] }, { "availability": { "stack": { "since": "7.10.0", "stability": "stable" } }, "description": "Retrieve shard-level statistics about searchable snapshots.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "name": "searchable_snapshots.stats", "request": { "name": "Request", "namespace": "searchable_snapshots.stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "searchable_snapshots.stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_searchable_snapshots/stats" }, { "methods": [ "GET" ], "path": "/{index}/_searchable_snapshots/stats" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.2.0", "stability": "stable" } }, "description": "Activate a user profile.\n\nCreate or update a user profile on behalf of another user.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html", "name": "security.activate_user_profile", "privileges": { "cluster": [ "manage_user_profile" ] }, "request": { "name": "Request", "namespace": "security.activate_user_profile" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.activate_user_profile" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/profile/_activate" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "5.5.0", "stability": "stable" } }, "description": "Authenticate a user.\n\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html", "name": "security.authenticate", "request": { "name": "Request", "namespace": "security.authenticate" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.authenticate" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_security/_authenticate" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.15.0", "stability": "stable" } }, "description": "Bulk delete roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-delete-role.html", "name": "security.bulk_delete_role", "privileges": { "cluster": [ "manage_security" ] }, "request": { "name": "Request", "namespace": "security.bulk_delete_role" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.bulk_delete_role" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_security/role" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.15.0", "stability": "stable" } }, "description": "Bulk create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-put-role.html", "name": "security.bulk_put_role", "privileges": { "cluster": [ "manage_security" ] }, "request": { "name": "Request", "namespace": "security.bulk_put_role" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.bulk_put_role" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/role" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Updates the attributes of multiple existing API keys.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-update-api-keys.html", "name": "security.bulk_update_api_keys", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/api_key/_bulk_update" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Change passwords.\n\nChange the passwords of users in the native realm and built-in users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html", "name": "security.change_password", "request": { "name": "Request", "namespace": "security.change_password" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.change_password" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_security/user/{username}/_password" }, { "methods": [ "PUT", "POST" ], "path": "/_security/user/_password" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.10.0", "stability": "stable" } }, "description": "Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html", "name": "security.clear_api_key_cache", "privileges": { "cluster": [ "manage_security" ] }, "request": { "name": "Request", "namespace": "security.clear_api_key_cache" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.clear_api_key_cache" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/api_key/{ids}/_clear_cache" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html", "name": "security.clear_cached_privileges", "request": { "name": "Request", "namespace": "security.clear_cached_privileges" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.clear_cached_privileges" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/privilege/{application}/_clear_cache" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Clear the user cache.\n\nEvict users from the user cache. You can completely clear the cache or evict specific users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html", "name": "security.clear_cached_realms", "request": { "name": "Request", "namespace": "security.clear_cached_realms" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.clear_cached_realms" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/realm/{realms}/_clear_cache" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Clear the roles cache.\n\nEvict roles from the native role cache.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html", "name": "security.clear_cached_roles", "request": { "name": "Request", "namespace": "security.clear_cached_roles" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.clear_cached_roles" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/role/{name}/_clear_cache" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Clear service account token caches.\n\nEvict a subset of all entries from the service account token caches.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html", "extDocId": "service-accounts", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.clear_cached_service_tokens", "request": { "name": "Request", "namespace": "security.clear_cached_service_tokens" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.clear_cached_service_tokens" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.7.0", "stability": "stable" } }, "description": "Create an API key.\n\nCreate an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html", "name": "security.create_api_key", "privileges": { "cluster": [ "manage_own_api_key" ] }, "request": { "name": "Request", "namespace": "security.create_api_key" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.create_api_key" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_security/api_key" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Create a cross-cluster API key.\n\nCreate an API key of the `cross_cluster` type for the API key based remote cluster access.\nA `cross_cluster` API key cannot be used to authenticate through the REST interface.\n\nIMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.\n\nCross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.\n\nNOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property.\n\nA successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.\n\nCross-cluster API keys can only be updated with the update cross-cluster API key API.\nAttempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html", "extDocId": "remote-clusters-api-key", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/remote-clusters-api-key.html", "name": "security.create_cross_cluster_api_key", "privileges": { "cluster": [ "manage_security" ] }, "request": { "name": "Request", "namespace": "security.create_cross_cluster_api_key" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.create_cross_cluster_api_key" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/cross_cluster/api_key" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Create a service account token.\n\nCreate a service accounts token for access without requiring basic authentication.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html", "extDocId": "service-accounts", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.create_service_token", "request": { "name": "Request", "namespace": "security.create_service_token" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.create_service_token" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_security/service/{namespace}/{service}/credential/token/{name}" }, { "methods": [ "POST" ], "path": "/_security/service/{namespace}/{service}/credential/token" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "6.4.0", "stability": "stable" } }, "description": "Delete application privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html", "extDocId": "security-privileges", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.delete_privileges", "request": { "name": "Request", "namespace": "security.delete_privileges" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.delete_privileges" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_security/privilege/{application}/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Delete roles.\n\nDelete roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "name": "security.delete_role", "request": { "name": "Request", "namespace": "security.delete_role" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.delete_role" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_security/role/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.5.0", "stability": "stable" } }, "description": "Delete role mappings.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html", "name": "security.delete_role_mapping", "request": { "name": "Request", "namespace": "security.delete_role_mapping" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.delete_role_mapping" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_security/role_mapping/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.5.0", "stability": "stable" } }, "description": "Delete service account tokens.\n\nDelete service account tokens for a service in a specified namespace.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html", "extDocId": "service-accounts", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.delete_service_token", "request": { "name": "Request", "namespace": "security.delete_service_token" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.delete_service_token" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_security/service/{namespace}/{service}/credential/token/{name}" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Delete users.\n\nDelete users from the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html", "name": "security.delete_user", "request": { "name": "Request", "namespace": "security.delete_user" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.delete_user" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_security/user/{username}" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Disable users.\n\nDisable users in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html", "name": "security.disable_user", "request": { "name": "Request", "namespace": "security.disable_user" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.disable_user" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_security/user/{username}/_disable" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.2.0", "stability": "stable" } }, "description": "Disable a user profile.\n\nDisable user profiles so that they are not visible in user profile searches.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user-profile.html", "name": "security.disable_user_profile", "privileges": { "cluster": [ "manage_user_profile" ] }, "request": { "name": "Request", "namespace": "security.disable_user_profile" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.disable_user_profile" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_security/profile/{uid}/_disable" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Enable users.\n\nEnable users in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html", "name": "security.enable_user", "request": { "name": "Request", "namespace": "security.enable_user" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.enable_user" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_security/user/{username}/_enable" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.2.0", "stability": "stable" } }, "description": "Enable a user profile.\n\nEnable user profiles to make them visible in user profile searches.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user-profile.html", "name": "security.enable_user_profile", "privileges": { "cluster": [ "manage_user_profile" ] }, "request": { "name": "Request", "namespace": "security.enable_user_profile" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.enable_user_profile" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_security/profile/{uid}/_enable" } ] }, { "availability": { "stack": { "since": "8.0.0", "stability": "stable" } }, "description": "Enroll Kibana.\n\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html", "name": "security.enroll_kibana", "request": { "name": "Request", "namespace": "security.enroll_kibana" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.enroll_kibana" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_security/enroll/kibana" } ] }, { "availability": { "stack": { "since": "8.0.0", "stability": "stable" } }, "description": "Enroll a node.\n\nEnroll a new node to allow it to join an existing cluster with security features enabled.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-node-enrollment.html", "name": "security.enroll_node", "request": { "name": "Request", "namespace": "security.enroll_node" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.enroll_node" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_security/enroll/node" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.7.0", "stability": "stable" } }, "description": "Get API key information.\n\nRetrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html", "name": "security.get_api_key", "privileges": { "cluster": [ "manage_own_api_key", "read_security" ] }, "request": { "name": "Request", "namespace": "security.get_api_key" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.get_api_key" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_security/api_key" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.3.0", "stability": "stable" } }, "description": "Get builtin privileges.\n\nGet the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", "extDocId": "security-privileges", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.get_builtin_privileges", "privileges": { "cluster": [ "manage_security" ] }, "request": { "name": "Request", "namespace": "security.get_builtin_privileges" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.get_builtin_privileges" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_security/privilege/_builtin" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "6.4.0", "stability": "stable" } }, "description": "Get application privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html", "extDocId": "security-privileges", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.get_privileges", "request": { "name": "Request", "namespace": "security.get_privileges" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.get_privileges" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_security/privilege" }, { "methods": [ "GET" ], "path": "/_security/privilege/{application}" }, { "methods": [ "GET" ], "path": "/_security/privilege/{application}/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get roles.\n\nGet roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "name": "security.get_role", "privileges": { "cluster": [ "manage_security" ] }, "request": { "name": "Request", "namespace": "security.get_role" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.get_role" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_security/role/{name}" }, { "methods": [ "GET" ], "path": "/_security/role" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.5.0", "stability": "stable" } }, "description": "Get role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html", "extDocId": "mapping-roles", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-roles.html", "name": "security.get_role_mapping", "privileges": { "cluster": [ "manage_security" ] }, "request": { "name": "Request", "namespace": "security.get_role_mapping" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.get_role_mapping" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_security/role_mapping/{name}" }, { "methods": [ "GET" ], "path": "/_security/role_mapping" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.13.0", "stability": "stable" } }, "description": "Get service accounts.\n\nGet a list of service accounts that match the provided path parameters.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html", "extDocId": "service-accounts", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.get_service_accounts", "privileges": { "cluster": [ "manage_service_account" ] }, "request": { "name": "Request", "namespace": "security.get_service_accounts" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.get_service_accounts" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_security/service/{namespace}/{service}" }, { "methods": [ "GET" ], "path": "/_security/service/{namespace}" }, { "methods": [ "GET" ], "path": "/_security/service" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.13.0", "stability": "stable" } }, "description": "Get service account credentials.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html", "extDocId": "service-accounts", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.get_service_credentials", "request": { "name": "Request", "namespace": "security.get_service_credentials" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.get_service_credentials" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_security/service/{namespace}/{service}/credential" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Retrieve settings for the security system indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-settings.html", "name": "security.get_settings", "request": null, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_security/settings" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.5.0", "stability": "stable" } }, "description": "Get a token.\n\nCreate a bearer token for access without requiring basic authentication.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html", "name": "security.get_token", "request": { "name": "Request", "namespace": "security.get_token" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.get_token" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/oauth2/token" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Get users.\n\nGet information about users in the native realm and built-in users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html", "name": "security.get_user", "request": { "name": "Request", "namespace": "security.get_user" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.get_user" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_security/user/{username}" }, { "methods": [ "GET" ], "path": "/_security/user" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "6.5.0", "stability": "stable" } }, "description": "Get user privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html", "name": "security.get_user_privileges", "request": { "name": "Request", "namespace": "security.get_user_privileges" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.get_user_privileges" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_security/user/_privileges" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.2.0", "stability": "stable" } }, "description": "Get a user profile.\n\nGet a user's profile using the unique profile ID.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html", "name": "security.get_user_profile", "privileges": { "cluster": [ "manage_user_profile" ] }, "request": { "name": "Request", "namespace": "security.get_user_profile" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "security.get_user_profile" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_security/profile/{uid}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.9.0", "stability": "stable" } }, "description": "Grant an API key.\n\nCreate an API key on behalf of another user.\nThis API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API.\nThe caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created.\nIt is not possible to use this API to create an API key without that user’s credentials.\nThe user, for whom the authentication credentials is provided, can optionally \"run as\" (impersonate) another user.\nIn this case, the API key will be created on behalf of the impersonated user.\n\nThis API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf.\n\nA successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html", "name": "security.grant_api_key", "privileges": { "cluster": [ "grant_api_key" ] }, "request": { "name": "Request", "namespace": "security.grant_api_key" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.grant_api_key" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/api_key/grant" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.4.0", "stability": "stable" } }, "description": "Check user privileges.\n\nDetermine whether the specified user has a specified list of privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html", "extDocId": "security-privileges", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.has_privileges", "request": { "name": "Request", "namespace": "security.has_privileges" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.has_privileges" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_security/user/_has_privileges" }, { "methods": [ "GET", "POST" ], "path": "/_security/user/{user}/_has_privileges" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.3.0", "stability": "stable" } }, "description": "Check user profile privileges.\n\nDetermine whether the users associated with the specified user profile IDs have all the requested privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges-user-profile.html", "extDocId": "user-profile", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/user-profile.html", "name": "security.has_privileges_user_profile", "privileges": { "cluster": [ "manage_user_profile" ] }, "request": { "name": "Request", "namespace": "security.has_privileges_user_profile" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.has_privileges_user_profile" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_security/profile/_has_privileges" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.7.0", "stability": "stable" } }, "description": "Invalidate API keys.\n\nThis API invalidates API keys created by the create API key or grant API key APIs.\nInvalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html", "name": "security.invalidate_api_key", "privileges": { "cluster": [ "manage_api_key", "manage_own_api_key" ] }, "request": { "name": "Request", "namespace": "security.invalidate_api_key" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.invalidate_api_key" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_security/api_key" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.5.0", "stability": "stable" } }, "description": "Invalidate a token.\n\nThe access tokens returned by the get token API have a finite period of time for which they are valid.\nAfter that time period, they can no longer be used.\nThe time period is defined by the `xpack.security.authc.token.timeout` setting.\n\nThe refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once.\nIf you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html", "name": "security.invalidate_token", "request": { "name": "Request", "namespace": "security.invalidate_token" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.invalidate_token" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_security/oauth2/token" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-authenticate.html", "name": "security.oidc_authenticate", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/oidc/authenticate" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-logout.html", "name": "security.oidc_logout", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/oidc/logout" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Creates an OAuth 2.0 authentication request as a URL string", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-prepare-authentication.html", "name": "security.oidc_prepare_authentication", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/oidc/prepare" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "6.4.0", "stability": "stable" } }, "description": "Create or update application privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html", "extDocId": "security-privileges", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.put_privileges", "request": { "name": "Request", "namespace": "security.put_privileges" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.put_privileges" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_security/privilege" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", "extDocId": "defining-roles", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/defining-roles.html", "name": "security.put_role", "privileges": { "cluster": [ "manage_security" ] }, "request": { "name": "Request", "namespace": "security.put_role" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.put_role" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_security/role/{name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "5.5.0", "stability": "stable" } }, "description": "Create or update role mappings.\n\nRole mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.\n\nThis API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html", "extDocId": "mapping-roles", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-roles.html", "name": "security.put_role_mapping", "request": { "name": "Request", "namespace": "security.put_role_mapping" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.put_role_mapping" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_security/role_mapping/{name}" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Create or update users.\n\nA password is required for adding a new user but is optional when updating an existing user.\nTo change a user’s password without updating any other fields, use the change password API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html", "name": "security.put_user", "request": { "name": "Request", "namespace": "security.put_user" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.put_user" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_security/user/{username}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.15.0", "stability": "stable" } }, "description": "Find API keys with a query.\n\nGet a paginated list of API keys and their information. You can optionally filter the results with a query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html", "name": "security.query_api_keys", "privileges": { "cluster": [ "manage_own_api_key", "read_security" ] }, "request": { "name": "Request", "namespace": "security.query_api_keys" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.query_api_keys" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_security/_query/api_key" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.15.0", "stability": "stable" } }, "description": "Find roles with a query.\n\nGet roles in a paginated manner. You can optionally filter the results with a query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-role.html", "name": "security.query_role", "privileges": { "cluster": [ "read_security" ] }, "request": { "name": "Request", "namespace": "security.query_role" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.query_role" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_security/_query/role" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.14.0", "stability": "stable" } }, "description": "Find users with a query.\n\nGet information for users in a paginated manner.\nYou can optionally filter the results with a query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-user.html", "name": "security.query_user", "privileges": { "cluster": [ "read_security" ] }, "request": { "name": "Request", "namespace": "security.query_user" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.query_user" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_security/_query/user" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Authenticate SAML.\n\nSubmits a SAML response message to Elasticsearch for consumption.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html", "name": "security.saml_authenticate", "request": { "name": "Request", "namespace": "security.saml_authenticate" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.saml_authenticate" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/saml/authenticate" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.14.0", "stability": "stable" } }, "description": "Logout of SAML completely.\n\nVerifies the logout response sent from the SAML IdP.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html", "name": "security.saml_complete_logout", "request": { "name": "Request", "namespace": "security.saml_complete_logout" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.saml_complete_logout" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/saml/complete_logout" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Invalidate SAML.\n\nSubmits a SAML LogoutRequest message to Elasticsearch for consumption.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html", "name": "security.saml_invalidate", "request": { "name": "Request", "namespace": "security.saml_invalidate" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.saml_invalidate" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/saml/invalidate" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Logout of SAML.\n\nSubmits a request to invalidate an access token and refresh token.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html", "name": "security.saml_logout", "request": { "name": "Request", "namespace": "security.saml_logout" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.saml_logout" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/saml/logout" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Prepare SAML authentication.\n\nCreates a SAML authentication request (``) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html", "name": "security.saml_prepare_authentication", "request": { "name": "Request", "namespace": "security.saml_prepare_authentication" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.saml_prepare_authentication" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_security/saml/prepare" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.11.0", "stability": "stable" } }, "description": "Create SAML service provider metadata.\n\nGenerate SAML metadata for a SAML 2.0 Service Provider.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html", "name": "security.saml_service_provider_metadata", "request": { "name": "Request", "namespace": "security.saml_service_provider_metadata" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.saml_service_provider_metadata" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_security/saml/metadata/{realm_name}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.2.0", "stability": "stable" } }, "description": "Suggest a user profile.\n\nGet suggestions for user profiles that match specified search criteria.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-suggest-user-profile.html", "name": "security.suggest_user_profiles", "request": { "name": "Request", "namespace": "security.suggest_user_profiles" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.suggest_user_profiles" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_security/profile/_suggest" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.4.0", "stability": "stable" } }, "description": "Update an API key.\n\nUpdates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request, and a snapshot of the owner user’s permissions at the time of the request.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html", "name": "security.update_api_key", "privileges": { "cluster": [ "manage_own_api_key" ] }, "request": { "name": "Request", "namespace": "security.update_api_key" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.update_api_key" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_security/api_key/{id}" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Update a cross-cluster API key.\n\nUpdate the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-cross-cluster-api-key.html", "extDocId": "remote-clusters-api-key", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/remote-clusters-api-key.html", "name": "security.update_cross_cluster_api_key", "request": { "name": "Request", "namespace": "security.update_cross_cluster_api_key" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.update_cross_cluster_api_key" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_security/cross_cluster/api_key/{id}" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Update settings for the security system index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-settings.html", "name": "security.update_settings", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_security/settings" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.2.0", "stability": "stable" } }, "description": "Update user profile data.\n\nUpdate specific data for the user profile that is associated with a unique ID.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-user-profile-data.html", "name": "security.update_user_profile_data", "privileges": { "cluster": [ "manage_user_profile" ] }, "request": { "name": "Request", "namespace": "security.update_user_profile_data" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "security.update_user_profile_data" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_security/profile/{uid}/_data" } ] }, { "availability": { "stack": { "since": "7.13.0", "stability": "stable" } }, "description": "Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", "name": "shutdown.delete_node", "request": { "name": "Request", "namespace": "shutdown.delete_node" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "shutdown.delete_node" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_nodes/{node_id}/shutdown" } ] }, { "availability": { "stack": { "since": "7.13.0", "stability": "stable" } }, "description": "Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", "name": "shutdown.get_node", "request": { "name": "Request", "namespace": "shutdown.get_node" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "shutdown.get_node" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_nodes/shutdown" }, { "methods": [ "GET" ], "path": "/_nodes/{node_id}/shutdown" } ] }, { "availability": { "stack": { "since": "7.13.0", "stability": "stable" } }, "description": "Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", "name": "shutdown.put_node", "request": { "name": "Request", "namespace": "shutdown.put_node" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "shutdown.put_node" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_nodes/{node_id}/shutdown" } ] }, { "availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "description": "Simulates running ingest with example documents.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-ingest-api.html", "name": "simulate.ingest", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_ingest/_simulate" }, { "methods": [ "GET", "POST" ], "path": "/_ingest/{index}/_simulate" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.4.0", "stability": "stable" } }, "description": "Deletes an existing snapshot lifecycle policy.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html", "name": "slm.delete_lifecycle", "request": { "name": "Request", "namespace": "slm.delete_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "slm.delete_lifecycle" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_slm/policy/{policy_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.4.0", "stability": "stable" } }, "description": "Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html", "name": "slm.execute_lifecycle", "request": { "name": "Request", "namespace": "slm.execute_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "slm.execute_lifecycle" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_slm/policy/{policy_id}/_execute" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Deletes any snapshots that are expired according to the policy's retention rules.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html", "name": "slm.execute_retention", "request": { "name": "Request", "namespace": "slm.execute_retention" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "slm.execute_retention" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_slm/_execute_retention" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.4.0", "stability": "stable" } }, "description": "Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html", "name": "slm.get_lifecycle", "request": { "name": "Request", "namespace": "slm.get_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "slm.get_lifecycle" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_slm/policy/{policy_id}" }, { "methods": [ "GET" ], "path": "/_slm/policy" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Returns global and policy-level statistics about actions taken by snapshot lifecycle management.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-get-stats.html", "name": "slm.get_stats", "request": { "name": "Request", "namespace": "slm.get_stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "slm.get_stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_slm/stats" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.6.0", "stability": "stable" } }, "description": "Retrieves the status of snapshot lifecycle management (SLM).", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html", "name": "slm.get_status", "request": { "name": "Request", "namespace": "slm.get_status" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "slm.get_status" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_slm/status" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.4.0", "stability": "stable" } }, "description": "Creates or updates a snapshot lifecycle policy.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html", "name": "slm.put_lifecycle", "request": { "name": "Request", "namespace": "slm.put_lifecycle" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "slm.put_lifecycle" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_slm/policy/{policy_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.6.0", "stability": "stable" } }, "description": "Turns on snapshot lifecycle management (SLM).", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html", "name": "slm.start", "request": { "name": "Request", "namespace": "slm.start" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "slm.start" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_slm/start" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.6.0", "stability": "stable" } }, "description": "Turns off snapshot lifecycle management (SLM).", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html", "name": "slm.stop", "request": { "name": "Request", "namespace": "slm.stop" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "slm.stop" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_slm/stop" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.4.0", "stability": "stable" } }, "description": "Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clean-up-snapshot-repo-api.html", "name": "snapshot.cleanup_repository", "request": { "name": "Request", "namespace": "snapshot.cleanup_repository" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "snapshot.cleanup_repository" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_snapshot/{repository}/_cleanup" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.10.0", "stability": "stable" } }, "description": "Clones indices from one snapshot into another snapshot in the same repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.clone", "request": { "name": "Request", "namespace": "snapshot.clone" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "snapshot.clone" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "0.0.0", "stability": "stable" } }, "description": "Creates a snapshot in a repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.create", "request": { "name": "Request", "namespace": "snapshot.create" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "snapshot.create" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_snapshot/{repository}/{snapshot}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "0.0.0", "stability": "stable" } }, "description": "Creates a repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.create_repository", "request": { "name": "Request", "namespace": "snapshot.create_repository" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "snapshot.create_repository" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_snapshot/{repository}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Deletes one or more snapshots.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.delete", "request": { "name": "Request", "namespace": "snapshot.delete" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "snapshot.delete" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_snapshot/{repository}/{snapshot}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "0.0.0", "stability": "stable" } }, "description": "Deletes a repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.delete_repository", "request": { "name": "Request", "namespace": "snapshot.delete_repository" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "snapshot.delete_repository" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_snapshot/{repository}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "0.0.0", "stability": "stable" } }, "description": "Returns information about a snapshot.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.get", "request": { "name": "Request", "namespace": "snapshot.get" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "snapshot.get" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_snapshot/{repository}/{snapshot}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "0.0.0", "stability": "stable" } }, "description": "Returns information about a repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.get_repository", "request": { "name": "Request", "namespace": "snapshot.get_repository" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "snapshot.get_repository" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_snapshot" }, { "methods": [ "GET" ], "path": "/_snapshot/{repository}" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Analyzes a repository for correctness and performance", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.repository_analyze", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_snapshot/{repository}/_analyze" } ] }, { "availability": { "stack": { "since": "8.16.0", "stability": "experimental", "visibility": "private" } }, "description": "Verifies the integrity of the contents of a snapshot repository", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.repository_verify_integrity", "request": { "name": "Request", "namespace": "snapshot.repository_verify_integrity" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "snapshot.repository_verify_integrity" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_snapshot/{repository}/_verify_integrity" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "0.0.0", "stability": "stable" } }, "description": "Restores a snapshot.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.restore", "request": { "name": "Request", "namespace": "snapshot.restore" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "snapshot.restore" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_snapshot/{repository}/{snapshot}/_restore" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.8.0", "stability": "stable" } }, "description": "Returns information about the status of a snapshot.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.status", "request": { "name": "Request", "namespace": "snapshot.status" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "snapshot.status" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_snapshot/_status" }, { "methods": [ "GET" ], "path": "/_snapshot/{repository}/_status" }, { "methods": [ "GET" ], "path": "/_snapshot/{repository}/{snapshot}/_status" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "0.0.0", "stability": "stable" } }, "description": "Verifies a repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.verify_repository", "request": { "name": "Request", "namespace": "snapshot.verify_repository" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "snapshot.verify_repository" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_snapshot/{repository}/_verify" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.3.0", "stability": "stable" } }, "description": "Clear an SQL search cursor.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html", "name": "sql.clear_cursor", "request": { "name": "Request", "namespace": "sql.clear_cursor" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "sql.clear_cursor" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_sql/close" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.15.0", "stability": "stable" } }, "description": "Delete an async SQL search.\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html", "name": "sql.delete_async", "request": { "name": "Request", "namespace": "sql.delete_async" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "sql.delete_async" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_sql/async/delete/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.15.0", "stability": "stable" } }, "description": "Get async SQL search results.\nGet the current status and available results for an async SQL search or stored synchronous SQL search.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html", "name": "sql.get_async", "request": { "name": "Request", "namespace": "sql.get_async" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "sql.get_async" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_sql/async/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.15.0", "stability": "stable" } }, "description": "Get the async SQL search status.\nGet the current status of an async SQL search or a stored synchronous SQL search.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-status-api.html", "name": "sql.get_async_status", "request": { "name": "Request", "namespace": "sql.get_async_status" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "sql.get_async_status" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_sql/async/status/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.3.0", "stability": "stable" } }, "description": "Get SQL search results.\nRun an SQL request.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html", "name": "sql.query", "request": { "name": "Request", "namespace": "sql.query" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "sql.query" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST", "GET" ], "path": "/_sql" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "6.3.0", "stability": "stable" } }, "description": "Translate SQL into Elasticsearch queries.\nTranslate an SQL search into a search API request containing Query DSL.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html", "name": "sql.translate", "request": { "name": "Request", "namespace": "sql.translate" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "sql.translate" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST", "GET" ], "path": "/_sql/translate" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "6.2.0", "stability": "stable" } }, "description": "Get SSL certificates.\n\nGet information about the X.509 certificates that are used to encrypt communications in the cluster.\nThe API returns a list that includes certificates from all TLS contexts including:\n\n- Settings for transport and HTTP interfaces\n- TLS settings that are used within authentication realms\n- TLS settings for remote monitoring exporters\n\nThe list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings.\nIt also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`.\n\nThe list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch.\n\nNOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration.\n\nIf Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.", "docTag": "security", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html", "name": "ssl.certificates", "request": { "name": "Request", "namespace": "ssl.certificates" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "ssl.certificates" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_ssl/certificates" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", "stability": "stable" } }, "description": "Delete a synonym set.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonyms-set.html", "name": "synonyms.delete_synonym", "request": { "name": "Request", "namespace": "synonyms.delete_synonym" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "synonyms.delete_synonym" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_synonyms/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", "stability": "stable" } }, "description": "Delete a synonym rule.\nDelete a synonym rule from a synonym set.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonym-rule.html", "name": "synonyms.delete_synonym_rule", "request": { "name": "Request", "namespace": "synonyms.delete_synonym_rule" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "synonyms.delete_synonym_rule" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_synonyms/{set_id}/{rule_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", "stability": "stable" } }, "description": "Get a synonym set.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonyms-set.html", "name": "synonyms.get_synonym", "request": { "name": "Request", "namespace": "synonyms.get_synonym" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "synonyms.get_synonym" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_synonyms/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", "stability": "stable" } }, "description": "Get a synonym rule.\nGet a synonym rule from a synonym set.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonym-rule.html", "name": "synonyms.get_synonym_rule", "request": { "name": "Request", "namespace": "synonyms.get_synonym_rule" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "synonyms.get_synonym_rule" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_synonyms/{set_id}/{rule_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", "stability": "stable" } }, "description": "Get all synonym sets.\nGet a summary of all defined synonym sets.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-synonyms-sets.html", "name": "synonyms.get_synonyms_sets", "request": { "name": "Request", "namespace": "synonyms.get_synonyms_sets" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "synonyms.get_synonyms_sets" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_synonyms" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", "stability": "stable" } }, "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonyms-set.html", "name": "synonyms.put_synonym", "request": { "name": "Request", "namespace": "synonyms.put_synonym" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "synonyms.put_synonym" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_synonyms/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.10.0", "stability": "stable" } }, "description": "Create or update a synonym rule.\nCreate or update a synonym rule in a synonym set.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonym-rule.html", "name": "synonyms.put_synonym_rule", "request": { "name": "Request", "namespace": "synonyms.put_synonym_rule" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "synonyms.put_synonym_rule" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_synonyms/{set_id}/{rule_id}" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "private" }, "stack": { "since": "2.3.0", "stability": "experimental" } }, "description": "Cancels a task, if it can be cancelled through an API.", "docId": "tasks", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", "name": "tasks.cancel", "request": { "name": "Request", "namespace": "tasks.cancel" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "tasks.cancel" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_tasks/_cancel" }, { "methods": [ "POST" ], "path": "/_tasks/{task_id}/_cancel" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "public" }, "stack": { "since": "5.0.0", "stability": "experimental" } }, "description": "Get task information.\nReturns information about the tasks currently executing in the cluster.", "docId": "tasks", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", "name": "tasks.get", "request": { "name": "Request", "namespace": "tasks.get" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "tasks.get" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_tasks/{task_id}" } ] }, { "availability": { "serverless": { "stability": "experimental", "visibility": "private" }, "stack": { "since": "2.3.0", "stability": "experimental" } }, "description": "The task management API returns information about tasks currently executing on one or more nodes in the cluster.", "docId": "tasks", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", "name": "tasks.list", "privileges": { "cluster": [ "monitor", "manage" ] }, "request": { "name": "Request", "namespace": "tasks.list" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "tasks.list" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_tasks" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.14.0", "stability": "stable" } }, "description": "Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis \"terms enum\" API is designed for low-latency look-ups used in auto-complete scenarios.\n\nIf the `complete` property in the response is false, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.\n\nNOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html", "name": "terms_enum", "request": { "name": "Request", "namespace": "_global.terms_enum" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.terms_enum" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/{index}/_terms_enum" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Get term vector information.\n\nGet information and statistics about terms in the fields of a particular document.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html", "name": "termvectors", "request": { "name": "Request", "namespace": "_global.termvectors" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.termvectors" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/{index}/_termvectors/{id}" }, { "methods": [ "GET", "POST" ], "path": "/{index}/_termvectors" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Finds the structure of a text field in an index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-field-structure.html", "name": "text_structure.find_field_structure", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_text_structure/find_field_structure" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-message-structure.html", "name": "text_structure.find_message_structure", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_text_structure/find_message_structure" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.13.0", "stability": "stable" } }, "description": "Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html", "name": "text_structure.find_structure", "request": { "name": "Request", "namespace": "text_structure.find_structure" }, "requestBodyRequired": true, "requestMediaType": [ "application/x-ndjson" ], "response": { "name": "Response", "namespace": "text_structure.find_structure" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_text_structure/find_structure" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "8.13.0", "stability": "stable" } }, "description": "Tests a Grok pattern on some text.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-grok-pattern.html", "name": "text_structure.test_grok_pattern", "request": { "name": "Request", "namespace": "text_structure.test_grok_pattern" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "text_structure.test_grok_pattern" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_text_structure/test_grok_pattern" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Delete a transform.\nDeletes a transform.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", "name": "transform.delete_transform", "privileges": { "cluster": [ "manage_transform" ] }, "request": { "name": "Request", "namespace": "transform.delete_transform" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "transform.delete_transform" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_transform/{transform_id}" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Retrieves transform usage information for transform nodes.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-node-stats.html", "name": "transform.get_node_stats", "request": null, "requestBodyRequired": false, "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_transform/_node_stats" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Get transforms.\nRetrieves configuration information for transforms.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", "name": "transform.get_transform", "privileges": { "cluster": [ "monitor_transform" ] }, "request": { "name": "Request", "namespace": "transform.get_transform" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "transform.get_transform" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_transform/{transform_id}" }, { "methods": [ "GET" ], "path": "/_transform" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Get transform stats.\nRetrieves usage information for transforms.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", "name": "transform.get_transform_stats", "privileges": { "cluster": [ "monitor_transform" ], "index": [ "read", "view_index_metadata" ] }, "request": { "name": "Request", "namespace": "transform.get_transform_stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "transform.get_transform_stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_transform/{transform_id}/_stats" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.2.0", "stability": "stable" } }, "description": "Preview a transform.\nGenerates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", "name": "transform.preview_transform", "privileges": { "cluster": [ "manage_transform" ], "index": [ "read", "view_index_metadata" ] }, "request": { "name": "Request", "namespace": "transform.preview_transform" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "transform.preview_transform" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_transform/{transform_id}/_preview" }, { "methods": [ "GET", "POST" ], "path": "/_transform/_preview" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.2.0", "stability": "stable" } }, "description": "Create a transform.\nCreates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", "name": "transform.put_transform", "privileges": { "cluster": [ "manage_transform" ], "index": [ "create_index", "read", "index", "view_index_metadata" ] }, "request": { "name": "Request", "namespace": "transform.put_transform" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "transform.put_transform" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_transform/{transform_id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.1.0", "stability": "stable" } }, "description": "Reset a transform.\nResets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html", "name": "transform.reset_transform", "privileges": { "cluster": [ "manage_transform" ] }, "request": { "name": "Request", "namespace": "transform.reset_transform" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "transform.reset_transform" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_transform/{transform_id}/_reset" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "8.7.0", "stability": "stable" } }, "description": "Schedule a transform to start now.\nInstantly runs a transform to process data.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html", "name": "transform.schedule_now_transform", "privileges": { "cluster": [ "manage_transform" ] }, "request": { "name": "Request", "namespace": "transform.schedule_now_transform" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "transform.schedule_now_transform" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_transform/{transform_id}/_schedule_now" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Start a transform.\nStarts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", "name": "transform.start_transform", "privileges": { "cluster": [ "manage_transform" ], "index": [ "read", "view_index_metadata" ] }, "request": { "name": "Request", "namespace": "transform.start_transform" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "transform.start_transform" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_transform/{transform_id}/_start" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.5.0", "stability": "stable" } }, "description": "Stop transforms.\nStops one or more transforms.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", "name": "transform.stop_transform", "privileges": { "cluster": [ "manage_transform" ] }, "request": { "name": "Request", "namespace": "transform.stop_transform" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "transform.stop_transform" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_transform/{transform_id}/_stop" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "7.2.0", "stability": "stable" } }, "description": "Update a transform.\nUpdates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", "name": "transform.update_transform", "privileges": { "cluster": [ "manage_transform" ], "index": [ "read", "index", "view_index_metadata" ] }, "request": { "name": "Request", "namespace": "transform.update_transform" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "transform.update_transform" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_transform/{transform_id}/_update" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "7.16.0", "stability": "stable" } }, "description": "Upgrades all transforms.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It\nalso cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not\naffect the source and destination indices. The upgrade also does not affect the roles that transforms use when\nElasticsearch security features are enabled; the role used to read source data and write to the destination index\nremains unchanged.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html", "name": "transform.upgrade_transforms", "privileges": { "cluster": [ "manage_transform" ] }, "request": { "name": "Request", "namespace": "transform.upgrade_transforms" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "transform.upgrade_transforms" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_transform/_upgrade" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "stability": "stable" } }, "description": "Update a document.\nUpdates a document by running a script or passing a partial document.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html", "name": "update", "request": { "name": "Request", "namespace": "_global.update" }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.update" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/{index}/_update/{id}" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "public" }, "stack": { "since": "2.4.0", "stability": "stable" } }, "description": "Update documents.\nUpdates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html", "name": "update_by_query", "request": { "name": "Request", "namespace": "_global.update_by_query" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "_global.update_by_query" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/{index}/_update_by_query" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "since": "6.5.0", "stability": "stable" } }, "description": "Throttle an update by query operation.\n\nChange the number of requests per second for a particular update by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html", "name": "update_by_query_rethrottle", "request": { "name": "Request", "namespace": "_global.update_by_query_rethrottle" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "_global.update_by_query_rethrottle" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_update_by_query/{task_id}/_rethrottle" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Acknowledges a watch, manually throttling the execution of the watch's actions.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html", "name": "watcher.ack_watch", "request": { "name": "Request", "namespace": "watcher.ack_watch" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "watcher.ack_watch" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_watcher/watch/{watch_id}/_ack" }, { "methods": [ "PUT", "POST" ], "path": "/_watcher/watch/{watch_id}/_ack/{action_id}" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Activates a currently inactive watch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html", "name": "watcher.activate_watch", "request": { "name": "Request", "namespace": "watcher.activate_watch" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "watcher.activate_watch" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_watcher/watch/{watch_id}/_activate" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Deactivates a currently active watch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html", "name": "watcher.deactivate_watch", "request": { "name": "Request", "namespace": "watcher.deactivate_watch" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "watcher.deactivate_watch" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_watcher/watch/{watch_id}/_deactivate" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Removes a watch from Watcher.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html", "name": "watcher.delete_watch", "request": { "name": "Request", "namespace": "watcher.delete_watch" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "watcher.delete_watch" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "DELETE" ], "path": "/_watcher/watch/{id}" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.\nFor testing and debugging purposes, you also have fine-grained control on how the watch runs. You can execute the watch without executing all of its actions or alternatively by simulating them. You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after execution.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html", "name": "watcher.execute_watch", "privileges": { "cluster": [ "manage_watcher" ] }, "request": { "name": "Request", "namespace": "watcher.execute_watch" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "watcher.execute_watch" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_watcher/watch/{id}/_execute" }, { "methods": [ "PUT", "POST" ], "path": "/_watcher/watch/_execute" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Retrieve settings for the watcher system index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-settings.html", "name": "watcher.get_settings", "request": null, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_watcher/settings" } ] }, { "availability": { "stack": { "since": "5.6.0", "stability": "stable" } }, "description": "Retrieves a watch by its ID.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html", "name": "watcher.get_watch", "request": { "name": "Request", "namespace": "watcher.get_watch" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "watcher.get_watch" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_watcher/watch/{id}" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Creates a new watch, or updates an existing one.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html", "name": "watcher.put_watch", "request": { "name": "Request", "namespace": "watcher.put_watch" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "watcher.put_watch" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT", "POST" ], "path": "/_watcher/watch/{id}" } ] }, { "availability": { "stack": { "since": "7.11.0", "stability": "stable" } }, "description": "Retrieves stored watches.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html", "name": "watcher.query_watches", "request": { "name": "Request", "namespace": "watcher.query_watches" }, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", "namespace": "watcher.query_watches" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET", "POST" ], "path": "/_watcher/_query/watches" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Starts Watcher if it is not already running.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html", "name": "watcher.start", "request": { "name": "Request", "namespace": "watcher.start" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "watcher.start" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_watcher/_start" } ] }, { "availability": { "stack": { "since": "5.5.0", "stability": "stable" } }, "description": "Retrieves the current Watcher metrics.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html", "name": "watcher.stats", "request": { "name": "Request", "namespace": "watcher.stats" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "watcher.stats" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_watcher/stats" }, { "methods": [ "GET" ], "path": "/_watcher/stats/{metric}" } ] }, { "availability": { "stack": { "stability": "stable" } }, "description": "Stops Watcher if it is running.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html", "name": "watcher.stop", "request": { "name": "Request", "namespace": "watcher.stop" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "watcher.stop" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "POST" ], "path": "/_watcher/_stop" } ] }, { "availability": { "stack": { "stability": "stable", "visibility": "public" } }, "description": "Update settings for the watcher system index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-update-settings.html", "name": "watcher.update_settings", "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": null, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "PUT" ], "path": "/_watcher/settings" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "Provides general information about the installed X-Pack features.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html", "name": "xpack.info", "privileges": { "cluster": [ "monitor", "manage" ] }, "request": { "name": "Request", "namespace": "xpack.info" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "xpack.info" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_xpack" } ] }, { "availability": { "serverless": { "stability": "stable", "visibility": "private" }, "stack": { "stability": "stable" } }, "description": "This API provides information about which features are currently enabled and available under the current license and some usage statistics.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html", "name": "xpack.usage", "privileges": { "cluster": [ "monitor", "manage" ] }, "request": { "name": "Request", "namespace": "xpack.usage" }, "requestBodyRequired": false, "response": { "name": "Response", "namespace": "xpack.usage" }, "responseMediaType": [ "application/json" ], "urls": [ { "methods": [ "GET" ], "path": "/_xpack/usage" } ] } ], "types": [ { "kind": "interface", "inherits": { "type": { "name": "WriteOperation", "namespace": "_global.bulk" } }, "name": { "name": "CreateOperation", "namespace": "_global.bulk" }, "properties": [], "specLocation": "_global/bulk/types.ts#L130-L130" }, { "kind": "interface", "inherits": { "type": { "name": "OperationBase", "namespace": "_global.bulk" } }, "name": { "name": "DeleteOperation", "namespace": "_global.bulk" }, "properties": [], "specLocation": "_global/bulk/types.ts#L134-L134" }, { "kind": "interface", "inherits": { "type": { "name": "WriteOperation", "namespace": "_global.bulk" } }, "name": { "name": "IndexOperation", "namespace": "_global.bulk" }, "properties": [], "specLocation": "_global/bulk/types.ts#L132-L132" }, { "kind": "interface", "name": { "name": "OperationBase", "namespace": "_global.bulk" }, "properties": [ { "description": "The document ID.", "name": "_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "Name of the index or index alias to perform the action on.", "name": "_index", "required": false, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } }, { "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "name": "if_primary_term", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "if_seq_no", "required": false, "type": { "kind": "instance_of", "type": { "name": "SequenceNumber", "namespace": "_types" } } }, { "name": "version", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionNumber", "namespace": "_types" } } }, { "name": "version_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionType", "namespace": "_types" } } } ], "specLocation": "_global/bulk/types.ts#L90-L107" }, { "kind": "interface", "name": { "name": "OperationContainer", "namespace": "_global.bulk" }, "properties": [ { "description": "Indexes the specified document.\nIf the document exists, replaces the document and increments the version.\nThe following line must contain the source data to be indexed.", "name": "index", "required": false, "type": { "kind": "instance_of", "type": { "name": "IndexOperation", "namespace": "_global.bulk" } } }, { "description": "Indexes the specified document if it does not already exist.\nThe following line must contain the source data to be indexed.", "name": "create", "required": false, "type": { "kind": "instance_of", "type": { "name": "CreateOperation", "namespace": "_global.bulk" } } }, { "description": "Performs a partial document update.\nThe following line must contain the partial document and update options.", "name": "update", "required": false, "type": { "kind": "instance_of", "type": { "name": "UpdateOperation", "namespace": "_global.bulk" } } }, { "description": "Removes the specified document from the index.", "name": "delete", "required": false, "type": { "kind": "instance_of", "type": { "name": "DeleteOperation", "namespace": "_global.bulk" } } } ], "specLocation": "_global/bulk/types.ts#L145-L167", "variants": { "kind": "container" } }, { "kind": "enum", "members": [ { "name": "index" }, { "name": "create" }, { "name": "update" }, { "name": "delete" } ], "name": { "name": "OperationType", "namespace": "_global.bulk" }, "specLocation": "_global/bulk/types.ts#L83-L88" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "value", "codegenName": "operations", "value": { "kind": "array_of", "value": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "OperationContainer", "namespace": "_global.bulk" } }, { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.bulk.Request" } }, { "kind": "instance_of", "type": { "name": "TPartialDocument", "namespace": "_global.bulk.Request" } } ], "type": { "name": "UpdateAction", "namespace": "_global.bulk" } }, { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.bulk.Request" } } ] } } }, "description": "Bulk index or delete documents.\nPerforms multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "generics": [ { "name": "TDocument", "namespace": "_global.bulk.Request" }, { "name": "TPartialDocument", "namespace": "_global.bulk.Request" } ], "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.bulk" }, "path": [ { "description": "Name of the data stream, index, or index alias to perform bulk actions on.", "name": "index", "required": false, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } } ], "query": [ { "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", "name": "pipeline", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", "name": "refresh", "required": false, "serverDefault": "false", "type": { "kind": "instance_of", "type": { "name": "Refresh", "namespace": "_types" } } }, { "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "`true` or `false` to return the `_source` field or not, or a list of fields to return.", "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "SourceConfigParam", "namespace": "_global.search._types" } } }, { "description": "A comma-separated list of source fields to exclude from the response.", "name": "_source_excludes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "A comma-separated list of source fields to include in the response.", "name": "_source_includes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.", "name": "timeout", "required": false, "serverDefault": "1m", "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "name": "wait_for_active_shards", "required": false, "serverDefault": "1", "type": { "kind": "instance_of", "type": { "name": "WaitForActiveShards", "namespace": "_types" } } }, { "description": "If `true`, the request’s actions must target an index alias.", "name": "require_alias", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/bulk/BulkRequest.ts#L32-L105" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "errors", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "items", "required": true, "type": { "kind": "array_of", "value": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "OperationType", "namespace": "_global.bulk" } }, "singleKey": true, "value": { "kind": "instance_of", "type": { "name": "ResponseItem", "namespace": "_global.bulk" } } } } }, { "name": "took", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "ingest_took", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } } ] }, "name": { "name": "Response", "namespace": "_global.bulk" }, "specLocation": "_global/bulk/BulkResponse.ts#L24-L31" }, { "kind": "interface", "name": { "name": "ResponseItem", "namespace": "_global.bulk" }, "properties": [ { "description": "The document ID associated with the operation.", "name": "_id", "required": false, "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, { "kind": "instance_of", "type": { "name": "null", "namespace": "_builtins" } } ] } }, { "description": "Name of the index associated with the operation.\nIf the operation targeted a data stream, this is the backing index into which the document was written.", "name": "_index", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "HTTP status code returned for the operation.", "name": "status", "required": true, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "Contains additional information about the failed operation.\nThe parameter is only returned for failed operations.", "name": "error", "required": false, "type": { "kind": "instance_of", "type": { "name": "ErrorCause", "namespace": "_types" } } }, { "description": "The primary term assigned to the document for the operation.", "name": "_primary_term", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "Result of the operation.\nSuccessful values are `created`, `deleted`, and `updated`.", "name": "result", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "The sequence number assigned to the document for the operation.\nSequence numbers are used to ensure an older version of a document doesn’t overwrite a newer version.", "name": "_seq_no", "required": false, "type": { "kind": "instance_of", "type": { "name": "SequenceNumber", "namespace": "_types" } } }, { "description": "Contains shard information for the operation.", "name": "_shards", "required": false, "type": { "kind": "instance_of", "type": { "name": "ShardStatistics", "namespace": "_types" } } }, { "description": "The document version associated with the operation.\nThe document version is incremented each time the document is updated.", "name": "_version", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionNumber", "namespace": "_types" } } }, { "name": "forced_refresh", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "get", "required": false, "type": { "kind": "instance_of", "generics": [ { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } ], "type": { "name": "InlineGet", "namespace": "_types" } } } ], "specLocation": "_global/bulk/types.ts#L37-L81" }, { "kind": "interface", "generics": [ { "name": "TDocument", "namespace": "_global.bulk.UpdateAction" }, { "name": "TPartialDocument", "namespace": "_global.bulk.UpdateAction" } ], "name": { "name": "UpdateAction", "namespace": "_global.bulk" }, "properties": [ { "description": "Set to false to disable setting 'result' in the response\nto 'noop' if no change to the document occurred.", "name": "detect_noop", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "A partial update to an existing document.", "name": "doc", "required": false, "type": { "kind": "instance_of", "type": { "name": "TPartialDocument", "namespace": "_global.bulk.UpdateAction" } } }, { "description": "Set to true to use the contents of 'doc' as the value of 'upsert'", "name": "doc_as_upsert", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Script to execute to update the document.", "name": "script", "required": false, "type": { "kind": "instance_of", "type": { "name": "Script", "namespace": "_types" } } }, { "description": "Set to true to execute the script whether or not the document exists.", "name": "scripted_upsert", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Set to false to disable source retrieval. You can also specify a comma-separated\nlist of the fields you want to retrieve.", "name": "_source", "required": false, "serverDefault": "true", "type": { "kind": "instance_of", "type": { "name": "SourceConfig", "namespace": "_global.search._types" } } }, { "description": "If the document does not already exist, the contents of 'upsert' are inserted as a\nnew document. If the document exists, the 'script' is executed.", "name": "upsert", "required": false, "type": { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.bulk.UpdateAction" } } } ], "specLocation": "_global/bulk/types.ts#L169-L205" }, { "kind": "interface", "inherits": { "type": { "name": "OperationBase", "namespace": "_global.bulk" } }, "name": { "name": "UpdateOperation", "namespace": "_global.bulk" }, "properties": [ { "description": "If `true`, the request’s actions must target an index alias.", "name": "require_alias", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "retry_on_conflict", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/bulk/types.ts#L136-L143" }, { "kind": "interface", "inherits": { "type": { "name": "OperationBase", "namespace": "_global.bulk" } }, "name": { "name": "WriteOperation", "namespace": "_global.bulk" }, "properties": [ { "description": "A map from the full name of fields to the name of dynamic templates.\nDefaults to an empty map.\nIf a name matches a dynamic template, then that template will be applied regardless of other match predicates defined in the template.\nIf a field is already defined in the mapping, then this parameter won’t be used.", "name": "dynamic_templates", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", "name": "pipeline", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If `true`, the request’s actions must target an index alias.", "name": "require_alias", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/bulk/types.ts#L109-L128" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "description": "Scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.", "name": "scroll_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "ScrollIds", "namespace": "_types" } } } ] }, "description": "Clear a scrolling search.\n\nClear the search context and results for a scrolling search.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.clear_scroll" }, "path": [ { "description": "Comma-separated list of scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.", "name": "scroll_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "ScrollIds", "namespace": "_types" } } } ], "query": [], "specLocation": "_global/clear_scroll/ClearScrollRequest.ts#L23-L48" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "succeeded", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "num_freed", "required": true, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ] }, "exceptions": [ { "body": { "kind": "properties", "properties": [ { "name": "succeeded", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "num_freed", "required": true, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ] }, "statusCodes": [ 404 ] } ], "name": { "name": "Response", "namespace": "_global.clear_scroll" }, "specLocation": "_global/clear_scroll/ClearScrollResponse.ts#L22-L36" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "description": "The ID of the point-in-time.", "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } } ] }, "description": "Close a point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no longer required for search requests.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.close_point_in_time" }, "path": [], "query": [], "specLocation": "_global/close_point_in_time/ClosePointInTimeRequest.ts#L23-L43" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "succeeded", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "num_freed", "required": true, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ] }, "exceptions": [ { "body": { "kind": "properties", "properties": [ { "name": "succeeded", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "num_freed", "required": true, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ] }, "statusCodes": [ 404 ] } ], "name": { "name": "Response", "namespace": "_global.close_point_in_time" }, "specLocation": "_global/close_point_in_time/ClosePointInTimeResponse.ts#L22-L36" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "description": "Defines the search definition using the Query DSL.", "name": "query", "required": false, "type": { "kind": "instance_of", "type": { "name": "QueryContainer", "namespace": "_types.query_dsl" } } } ] }, "description": "Count search results.\nGet the number of documents matching a query.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.count" }, "path": [ { "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.", "name": "index", "required": false, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } } ], "query": [ { "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", "name": "allow_no_indices", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Analyzer to use for the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can only be used when the `q` query string parameter is specified.", "name": "analyze_wildcard", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "The default operator for query string query: `AND` or `OR`.\nThis parameter can only be used when the `q` query string parameter is specified.", "name": "default_operator", "required": false, "type": { "kind": "instance_of", "type": { "name": "Operator", "namespace": "_types.query_dsl" } } }, { "description": "Field to use as default where no field prefix is given in the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", "name": "df", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "name": "expand_wildcards", "required": false, "serverDefault": "open", "type": { "kind": "instance_of", "type": { "name": "ExpandWildcards", "namespace": "_types" } } }, { "description": "If `true`, concrete, expanded or aliased indices are ignored when frozen.", "name": "ignore_throttled", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `false`, the request returns an error if it targets a missing or closed index.", "name": "ignore_unavailable", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", "name": "lenient", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Sets the minimum `_score` value that documents must have to be included in the result.", "name": "min_score", "required": false, "type": { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } } }, { "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "Maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.", "name": "terminate_after", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "Query in the Lucene query string syntax.", "name": "q", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } ], "specLocation": "_global/count/CountRequest.ts#L26-L123" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "count", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "_shards", "required": true, "type": { "kind": "instance_of", "type": { "name": "ShardStatistics", "namespace": "_types" } } } ] }, "name": { "name": "Response", "namespace": "_global.count" }, "specLocation": "_global/count/CountResponse.ts#L23-L25" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "value", "codegenName": "document", "value": { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.create.Request" } } }, "description": "Index a document.\nAdds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "generics": [ { "name": "TDocument", "namespace": "_global.create.Request" } ], "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.create" }, "path": [ { "description": "Unique identifier for the document.", "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "Name of the data stream or index to target.\nIf the target doesn’t exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.\nIf the target doesn’t exist and doesn’t match a data stream template, this request creates the index.", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } } ], "query": [ { "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", "name": "pipeline", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", "name": "refresh", "required": false, "serverDefault": "false", "type": { "kind": "instance_of", "type": { "name": "Refresh", "namespace": "_types" } } }, { "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.", "name": "timeout", "required": false, "serverDefault": "1m", "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionNumber", "namespace": "_types" } } }, { "description": "Specific version type: `external`, `external_gte`.", "name": "version_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionType", "namespace": "_types" } } }, { "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "name": "wait_for_active_shards", "required": false, "serverDefault": "1", "type": { "kind": "instance_of", "type": { "name": "WaitForActiveShards", "namespace": "_types" } } } ], "specLocation": "_global/create/CreateRequest.ts#L32-L96" }, { "kind": "response", "body": { "kind": "value", "value": { "kind": "instance_of", "type": { "name": "WriteResponseBase", "namespace": "_types" } } }, "name": { "name": "Response", "namespace": "_global.create" }, "specLocation": "_global/create/CreateResponse.ts#L22-L24" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "no_body" }, "description": "Delete a document.\nRemoves a JSON document from the specified index.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.delete" }, "path": [ { "description": "Unique identifier for the document.", "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "Name of the target index.", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } } ], "query": [ { "description": "Only perform the operation if the document has this primary term.", "name": "if_primary_term", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "Only perform the operation if the document has this sequence number.", "name": "if_seq_no", "required": false, "type": { "kind": "instance_of", "type": { "name": "SequenceNumber", "namespace": "_types" } } }, { "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", "name": "refresh", "required": false, "serverDefault": "false", "type": { "kind": "instance_of", "type": { "name": "Refresh", "namespace": "_types" } } }, { "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "Period to wait for active shards.", "name": "timeout", "required": false, "serverDefault": "1m", "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionNumber", "namespace": "_types" } } }, { "description": "Specific version type: `external`, `external_gte`.", "name": "version_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionType", "namespace": "_types" } } }, { "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "name": "wait_for_active_shards", "required": false, "serverDefault": "1", "type": { "kind": "instance_of", "type": { "name": "WaitForActiveShards", "namespace": "_types" } } } ], "specLocation": "_global/delete/DeleteRequest.ts#L34-L93" }, { "kind": "response", "body": { "kind": "value", "value": { "kind": "instance_of", "type": { "name": "WriteResponseBase", "namespace": "_types" } } }, "exceptions": [ { "body": { "kind": "value", "value": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "WriteResponseBase", "namespace": "_types" } }, { "kind": "instance_of", "type": { "name": "ErrorResponseBase", "namespace": "_types" } } ] } }, "description": "\nIf the index does exist, but the document does not,\nthe response is the same as the successful case, but with a 404.", "statusCodes": [ 404 ] } ], "name": { "name": "Response", "namespace": "_global.delete" }, "specLocation": "_global/delete/DeleteResponse.ts#L22-L34" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "description": "The maximum number of documents to delete.", "name": "max_docs", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "Specifies the documents to delete using the Query DSL.", "name": "query", "required": false, "type": { "kind": "instance_of", "type": { "name": "QueryContainer", "namespace": "_types.query_dsl" } } }, { "description": "Slice the request manually using the provided slice ID and total number of slices.", "name": "slice", "required": false, "type": { "kind": "instance_of", "type": { "name": "SlicedScroll", "namespace": "_types" } } } ] }, "description": "Delete documents.\nDeletes documents that match the specified query.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.delete_by_query" }, "path": [ { "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } } ], "query": [ { "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", "name": "allow_no_indices", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Analyzer to use for the query string.", "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If `true`, wildcard and prefix queries are analyzed.", "name": "analyze_wildcard", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "What to do if delete by query hits version conflicts: `abort` or `proceed`.", "name": "conflicts", "required": false, "serverDefault": "abort", "type": { "kind": "instance_of", "type": { "name": "Conflicts", "namespace": "_types" } } }, { "description": "The default operator for query string query: `AND` or `OR`.", "name": "default_operator", "required": false, "serverDefault": "OR", "type": { "kind": "instance_of", "type": { "name": "Operator", "namespace": "_types.query_dsl" } } }, { "description": "Field to use as default where no field prefix is given in the query string.", "name": "df", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.", "name": "expand_wildcards", "required": false, "serverDefault": "open", "type": { "kind": "instance_of", "type": { "name": "ExpandWildcards", "namespace": "_types" } } }, { "description": "Starting offset (default: 0)", "name": "from", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "If `false`, the request returns an error if it targets a missing or closed index.", "name": "ignore_unavailable", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", "name": "lenient", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Maximum number of documents to process.\nDefaults to all documents.", "name": "max_docs", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.", "name": "refresh", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, the request cache is used for this request.\nDefaults to the index-level setting.", "name": "request_cache", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "The throttle for this request in sub-requests per second.", "name": "requests_per_second", "required": false, "type": { "kind": "instance_of", "type": { "name": "float", "namespace": "_types" } } }, { "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "Query in the Lucene query string syntax.", "name": "q", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "Period to retain the search context for scrolling.", "name": "scroll", "required": false, "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "Size of the scroll request that powers the operation.", "name": "scroll_size", "required": false, "serverDefault": 1000, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "Explicit timeout for each search request.\nDefaults to no timeout.", "name": "search_timeout", "required": false, "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "The type of the search operation.\nAvailable options: `query_then_fetch`, `dfs_query_then_fetch`.", "name": "search_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "SearchType", "namespace": "_types" } } }, { "description": "The number of slices this task should be divided into.", "name": "slices", "required": false, "serverDefault": "1", "type": { "kind": "instance_of", "type": { "name": "Slices", "namespace": "_types" } } }, { "description": "A comma-separated list of : pairs.", "name": "sort", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "description": "Specific `tag` of the request for logging and statistical purposes.", "name": "stats", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "description": "Maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\nUse with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.", "name": "terminate_after", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "Period each deletion request waits for active shards.", "name": "timeout", "required": false, "serverDefault": "1m", "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "If `true`, returns the document version as part of a hit.", "name": "version", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "name": "wait_for_active_shards", "required": false, "serverDefault": "1", "type": { "kind": "instance_of", "type": { "name": "WaitForActiveShards", "namespace": "_types" } } }, { "description": "If `true`, the request blocks until the operation is complete.", "name": "wait_for_completion", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/delete_by_query/DeleteByQueryRequest.ts#L36-L211" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "batches", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "deleted", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "failures", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "BulkIndexByScrollFailure", "namespace": "_types" } } } }, { "name": "noops", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "requests_per_second", "required": false, "type": { "kind": "instance_of", "type": { "name": "float", "namespace": "_types" } } }, { "name": "retries", "required": false, "type": { "kind": "instance_of", "type": { "name": "Retries", "namespace": "_types" } } }, { "name": "slice_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "task", "required": false, "type": { "kind": "instance_of", "type": { "name": "TaskId", "namespace": "_types" } } }, { "name": "throttled", "required": false, "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "name": "throttled_millis", "required": false, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "UnitMillis", "namespace": "_types" } } ], "type": { "name": "DurationValue", "namespace": "_types" } } }, { "name": "throttled_until", "required": false, "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "name": "throttled_until_millis", "required": false, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "UnitMillis", "namespace": "_types" } } ], "type": { "name": "DurationValue", "namespace": "_types" } } }, { "name": "timed_out", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "took", "required": false, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "UnitMillis", "namespace": "_types" } } ], "type": { "name": "DurationValue", "namespace": "_types" } } }, { "name": "total", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "version_conflicts", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } } ] }, "name": { "name": "Response", "namespace": "_global.delete_by_query" }, "specLocation": "_global/delete_by_query/DeleteByQueryResponse.ts#L26-L45" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "no_body" }, "description": "Throttle a delete by query operation.\n\nChange the number of requests per second for a particular delete by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.delete_by_query_rethrottle" }, "path": [ { "description": "The ID for the task.", "name": "task_id", "required": true, "type": { "kind": "instance_of", "type": { "name": "TaskId", "namespace": "_types" } } } ], "query": [ { "description": "The throttle for this request in sub-requests per second.", "name": "requests_per_second", "required": false, "type": { "kind": "instance_of", "type": { "name": "float", "namespace": "_types" } } } ], "specLocation": "_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts#L24-L47" }, { "kind": "response", "body": { "kind": "value", "value": { "kind": "instance_of", "type": { "name": "TaskListResponseBase", "namespace": "tasks._types" } } }, "name": { "name": "Response", "namespace": "_global.delete_by_query_rethrottle" }, "specLocation": "_global/delete_by_query_rethrottle/DeleteByQueryRethrottleResponse.ts#L22-L24" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "no_body" }, "description": "Delete a script or search template.\nDeletes a stored script or search template.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.delete_script" }, "path": [ { "description": "Identifier for the stored script or search template.", "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } } ], "query": [ { "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "master_timeout", "required": false, "serverDefault": "30s", "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "serverDefault": "30s", "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } } ], "specLocation": "_global/delete_script/DeleteScriptRequest.ts#L24-L53" }, { "kind": "response", "body": { "kind": "value", "value": { "kind": "instance_of", "type": { "name": "AcknowledgedResponseBase", "namespace": "_types" } } }, "name": { "name": "Response", "namespace": "_global.delete_script" }, "specLocation": "_global/delete_script/DeleteScriptResponse.ts#L22-L24" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "no_body" }, "description": "Check a document.\nChecks if a specified document exists.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.exists" }, "path": [ { "description": "Identifier of the document.", "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "Comma-separated list of data streams, indices, and aliases.\nSupports wildcards (`*`).", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } } ], "query": [ { "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If `true`, the request is real-time as opposed to near-real-time.", "docId": "realtime", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime", "name": "realtime", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.", "name": "refresh", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Target the specified primary shard.", "docId": "routing", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#get-routing", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "`true` or `false` to return the `_source` field or not, or a list of fields to return.", "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "SourceConfigParam", "namespace": "_global.search._types" } } }, { "description": "A comma-separated list of source fields to exclude in the response.", "name": "_source_excludes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "A comma-separated list of source fields to include in the response.", "name": "_source_includes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "List of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to false.", "name": "stored_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionNumber", "namespace": "_types" } } }, { "description": "Specific version type: `external`, `external_gte`.", "name": "version_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionType", "namespace": "_types" } } } ], "specLocation": "_global/exists/DocumentExistsRequest.ts#L31-L101" }, { "kind": "response", "body": { "kind": "no_body" }, "name": { "name": "Response", "namespace": "_global.exists" }, "specLocation": "_global/exists/DocumentExistsResponse.ts#L22-L24" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "no_body" }, "description": "Check for a document source.\nChecks if a document's `_source` is stored.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.exists_source" }, "path": [ { "description": "Identifier of the document.", "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "Comma-separated list of data streams, indices, and aliases.\nSupports wildcards (`*`).", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } } ], "query": [ { "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If true, the request is real-time as opposed to near-real-time.", "docId": "realtime", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime", "name": "realtime", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.", "name": "refresh", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Target the specified primary shard.", "docId": "routing", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#get-routing", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "`true` or `false` to return the `_source` field or not, or a list of fields to return.", "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "SourceConfigParam", "namespace": "_global.search._types" } } }, { "description": "A comma-separated list of source fields to exclude in the response.", "name": "_source_excludes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "A comma-separated list of source fields to include in the response.", "name": "_source_includes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionNumber", "namespace": "_types" } } }, { "description": "Specific version type: `external`, `external_gte`.", "name": "version_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionType", "namespace": "_types" } } } ], "specLocation": "_global/exists_source/SourceExistsRequest.ts#L31-L95" }, { "kind": "response", "body": { "kind": "no_body" }, "name": { "name": "Response", "namespace": "_global.exists_source" }, "specLocation": "_global/exists_source/SourceExistsResponse.ts#L22-L24" }, { "kind": "interface", "name": { "name": "Explanation", "namespace": "_global.explain" }, "properties": [ { "name": "description", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "details", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "ExplanationDetail", "namespace": "_global.explain" } } } }, { "name": "value", "required": true, "type": { "kind": "instance_of", "type": { "name": "float", "namespace": "_types" } } } ], "specLocation": "_global/explain/types.ts#L22-L26" }, { "kind": "interface", "name": { "name": "ExplanationDetail", "namespace": "_global.explain" }, "properties": [ { "name": "description", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "details", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "ExplanationDetail", "namespace": "_global.explain" } } } }, { "name": "value", "required": true, "type": { "kind": "instance_of", "type": { "name": "float", "namespace": "_types" } } } ], "specLocation": "_global/explain/types.ts#L28-L32" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "description": "Defines the search definition using the Query DSL.", "name": "query", "required": false, "type": { "kind": "instance_of", "type": { "name": "QueryContainer", "namespace": "_types.query_dsl" } } } ] }, "description": "Explain a document match result.\nReturns information about why a specific document matches, or doesn’t match, a query.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.explain" }, "path": [ { "description": "Defines the document ID.", "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "Index names used to limit the request.\nOnly a single index name can be provided to this parameter.", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } } ], "query": [ { "description": "Analyzer to use for the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If `true`, wildcard and prefix queries are analyzed.", "name": "analyze_wildcard", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "The default operator for query string query: `AND` or `OR`.", "name": "default_operator", "required": false, "serverDefault": "OR", "type": { "kind": "instance_of", "type": { "name": "Operator", "namespace": "_types.query_dsl" } } }, { "description": "Field to use as default where no field prefix is given in the query string.", "name": "df", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", "name": "lenient", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "True or false to return the `_source` field or not, or a list of fields to return.", "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "SourceConfigParam", "namespace": "_global.search._types" } } }, { "description": "A comma-separated list of source fields to exclude from the response.", "name": "_source_excludes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "A comma-separated list of source fields to include in the response.", "name": "_source_includes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "A comma-separated list of stored fields to return in the response.", "name": "stored_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "Query in the Lucene query string syntax.", "name": "q", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } ], "specLocation": "_global/explain/ExplainRequest.ts#L26-L107" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "_index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } }, { "name": "_id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "name": "matched", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "explanation", "required": false, "type": { "kind": "instance_of", "type": { "name": "ExplanationDetail", "namespace": "_global.explain" } } }, { "name": "get", "required": false, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.explain.Response" } } ], "type": { "name": "InlineGet", "namespace": "_types" } } } ] }, "generics": [ { "name": "TDocument", "namespace": "_global.explain.Response" } ], "name": { "name": "Response", "namespace": "_global.explain" }, "specLocation": "_global/explain/ExplainResponse.ts#L23-L31" }, { "kind": "interface", "name": { "name": "FieldCapability", "namespace": "_global.field_caps" }, "properties": [ { "description": "Whether this field can be aggregated on all indices.", "name": "aggregatable", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "The list of indices where this field has the same type family, or null if all indices have the same type family for the field.", "name": "indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } }, { "description": "Merged metadata across all indices as a map of string keys to arrays of values. A value length of 1 indicates that all indices had the same value for this key, while a length of 2 or more indicates that not all indices had the same value for this key.", "name": "meta", "required": false, "type": { "kind": "instance_of", "type": { "name": "Metadata", "namespace": "_types" } } }, { "description": "The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field.", "name": "non_aggregatable_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } }, { "description": "The list of indices where this field is not searchable, or null if all indices have the same definition for the field.", "name": "non_searchable_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } }, { "description": "Whether this field is indexed for search on all indices.", "name": "searchable", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "type", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "Whether this field is registered as a metadata field.", "docId": "mapping-metadata", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-fields.html", "name": "metadata_field", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "availability": { "serverless": { "stability": "experimental" }, "stack": { "since": "8.0.0", "stability": "experimental" } }, "description": "Whether this field is used as a time series dimension.", "name": "time_series_dimension", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "availability": { "serverless": { "stability": "experimental" }, "stack": { "since": "8.0.0", "stability": "experimental" } }, "description": "Contains metric type if this fields is used as a time series\nmetrics, absent if the field is not used as metric.", "name": "time_series_metric", "required": false, "type": { "kind": "instance_of", "type": { "name": "TimeSeriesMetricType", "namespace": "_types.mapping" } } }, { "availability": { "serverless": { "stability": "experimental" }, "stack": { "since": "8.0.0", "stability": "experimental" } }, "description": "If this list is present in response then some indices have the\nfield marked as a dimension and other indices, the ones in this list, do not.", "name": "non_dimension_indices", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } } }, { "availability": { "serverless": { "stability": "experimental" }, "stack": { "since": "8.0.0", "stability": "experimental" } }, "description": "The list of indices where this field is present if these indices\ndon’t have the same `time_series_metric` value for this field.", "name": "metric_conflicts_indices", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } } } ], "specLocation": "_global/field_caps/types.ts#L23-L81" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "availability": { "serverless": {}, "stack": { "since": "8.5.0" } }, "description": "List of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.", "name": "fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "Allows to filter indices if the provided query rewrites to match_none on every shard.", "name": "index_filter", "required": false, "type": { "kind": "instance_of", "type": { "name": "QueryContainer", "namespace": "_types.query_dsl" } } }, { "availability": { "serverless": {}, "stack": { "since": "7.12.0" } }, "description": "Defines ad-hoc runtime fields in the request similar to the way it is done in search requests.\nThese fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.", "docId": "runtime-search-request", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/runtime-search-request.html", "name": "runtime_mappings", "required": false, "type": { "kind": "instance_of", "type": { "name": "RuntimeFields", "namespace": "_types.mapping" } } } ] }, "description": "Get the field capabilities.\n\nGet information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.field_caps" }, "path": [ { "description": "Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.", "name": "index", "required": false, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } } ], "query": [ { "description": "If false, the request returns an error if any wildcard expression, index alias,\nor `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request\ntargeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar.", "name": "allow_no_indices", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", "name": "expand_wildcards", "required": false, "serverDefault": "open", "type": { "kind": "instance_of", "type": { "name": "ExpandWildcards", "namespace": "_types" } } }, { "description": "Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.", "name": "fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "If `true`, missing or closed indices are not included in the response.", "name": "ignore_unavailable", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If true, unmapped fields are included in the response.", "name": "include_unmapped", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "availability": { "serverless": {}, "stack": { "since": "8.2.0" } }, "description": "An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent", "name": "filters", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "availability": { "serverless": {}, "stack": { "since": "8.2.0" } }, "description": "Only return results for fields that have one of the types in the list", "name": "types", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "availability": { "serverless": {}, "stack": { "since": "8.13.0" } }, "description": "If false, empty fields are not included in the response.", "name": "include_empty_fields", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/field_caps/FieldCapabilitiesRequest.ts#L25-L111" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "indices", "required": true, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } }, { "name": "fields", "required": true, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "Field", "namespace": "_types" } }, "singleKey": false, "value": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "FieldCapability", "namespace": "_global.field_caps" } } } } } ] }, "name": { "name": "Response", "namespace": "_global.field_caps" }, "specLocation": "_global/field_caps/FieldCapabilitiesResponse.ts#L24-L35" }, { "kind": "interface", "generics": [ { "name": "TDocument", "namespace": "_global.get.GetResult" } ], "name": { "name": "GetResult", "namespace": "_global.get" }, "properties": [ { "name": "_index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } }, { "name": "fields", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } }, { "name": "_ignored", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "name": "found", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "_id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "name": "_primary_term", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "_routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "_seq_no", "required": false, "type": { "kind": "instance_of", "type": { "name": "SequenceNumber", "namespace": "_types" } } }, { "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.get.GetResult" } } }, { "name": "_version", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionNumber", "namespace": "_types" } } } ], "specLocation": "_global/get/types.ts#L25-L36" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "no_body" }, "description": "Get a document by its ID.\nRetrieves the document with the specified ID from an index.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.get" }, "path": [ { "description": "Unique identifier of the document.", "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "Name of the index that contains the document.", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } } ], "query": [ { "availability": { "stack": { "featureFlag": "es.index_mode_feature_flag_registered", "since": "8.4.0", "visibility": "feature_flag" } }, "description": "Should this request force synthetic _source?\nUse this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.\nFetches with this enabled will be slower the enabling synthetic source natively in the index.", "name": "force_synthetic_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Specifies the node or shard the operation should be performed on. Random by default.", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If `true`, the request is real-time as opposed to near-real-time.", "docId": "realtime", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime", "name": "realtime", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.", "name": "refresh", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Target the specified primary shard.", "docId": "routing", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#get-routing", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "True or false to return the _source field or not, or a list of fields to return.", "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "SourceConfigParam", "namespace": "_global.search._types" } } }, { "description": "A comma-separated list of source fields to exclude in the response.", "name": "_source_excludes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "A comma-separated list of source fields to include in the response.", "name": "_source_includes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "List of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to false.", "name": "stored_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionNumber", "namespace": "_types" } } }, { "description": "Specific version type: internal, external, external_gte.", "name": "version_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionType", "namespace": "_types" } } } ], "specLocation": "_global/get/GetRequest.ts#L31-L101" }, { "kind": "response", "body": { "kind": "value", "value": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.get.Response" } } ], "type": { "name": "GetResult", "namespace": "_global.get" } } }, "exceptions": [ { "body": { "kind": "value", "value": { "kind": "union_of", "items": [ { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.get.Response" } } ], "type": { "name": "GetResult", "namespace": "_global.get" } }, { "kind": "instance_of", "type": { "name": "ErrorResponseBase", "namespace": "_types" } } ] } }, "statusCodes": [ 404 ] } ], "generics": [ { "name": "TDocument", "namespace": "_global.get.Response" } ], "name": { "name": "Response", "namespace": "_global.get" }, "specLocation": "_global/get/GetResponse.ts#L23-L34" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "no_body" }, "description": "Get a script or search template.\nRetrieves a stored script or search template.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.get_script" }, "path": [ { "description": "Identifier for the stored script or search template.", "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } } ], "query": [ { "description": "Specify timeout for connection to master", "name": "master_timeout", "required": false, "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } } ], "specLocation": "_global/get_script/GetScriptRequest.ts#L24-L43" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "_id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "name": "found", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "script", "required": false, "type": { "kind": "instance_of", "type": { "name": "StoredScript", "namespace": "_types" } } } ] }, "name": { "name": "Response", "namespace": "_global.get_script" }, "specLocation": "_global/get_script/GetScriptResponse.ts#L23-L29" }, { "kind": "interface", "name": { "name": "Context", "namespace": "_global.get_script_context" }, "properties": [ { "name": "methods", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "ContextMethod", "namespace": "_global.get_script_context" } } } }, { "name": "name", "required": true, "type": { "kind": "instance_of", "type": { "name": "Name", "namespace": "_types" } } } ], "specLocation": "_global/get_script_context/types.ts#L22-L25" }, { "kind": "interface", "name": { "name": "ContextMethod", "namespace": "_global.get_script_context" }, "properties": [ { "name": "name", "required": true, "type": { "kind": "instance_of", "type": { "name": "Name", "namespace": "_types" } } }, { "name": "return_type", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "params", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "ContextMethodParam", "namespace": "_global.get_script_context" } } } } ], "specLocation": "_global/get_script_context/types.ts#L27-L31" }, { "kind": "interface", "name": { "name": "ContextMethodParam", "namespace": "_global.get_script_context" }, "properties": [ { "name": "name", "required": true, "type": { "kind": "instance_of", "type": { "name": "Name", "namespace": "_types" } } }, { "name": "type", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } ], "specLocation": "_global/get_script_context/types.ts#L33-L36" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "no_body" }, "description": "Get script contexts.\n\nGet a list of supported script contexts and their methods.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.get_script_context" }, "path": [], "query": [], "specLocation": "_global/get_script_context/GetScriptContextRequest.ts#L22-L30" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "contexts", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "Context", "namespace": "_global.get_script_context" } } } } ] }, "name": { "name": "Response", "namespace": "_global.get_script_context" }, "specLocation": "_global/get_script_context/GetScriptContextResponse.ts#L22-L26" }, { "kind": "interface", "name": { "name": "LanguageContext", "namespace": "_global.get_script_languages" }, "properties": [ { "name": "contexts", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "name": "language", "required": true, "type": { "kind": "instance_of", "type": { "name": "ScriptLanguage", "namespace": "_types" } } } ], "specLocation": "_global/get_script_languages/types.ts#L22-L25" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "no_body" }, "description": "Get script languages.\n\nGet a list of available script types, languages, and contexts.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.get_script_languages" }, "path": [], "query": [], "specLocation": "_global/get_script_languages/GetScriptLanguagesRequest.ts#L22-L30" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "language_contexts", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "LanguageContext", "namespace": "_global.get_script_languages" } } } }, { "name": "types_allowed", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } } ] }, "name": { "name": "Response", "namespace": "_global.get_script_languages" }, "specLocation": "_global/get_script_languages/GetScriptLanguagesResponse.ts#L22-L27" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "no_body" }, "description": "Get a document's source.\nReturns the source of a document.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.get_source" }, "path": [ { "description": "Unique identifier of the document.", "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "Name of the index that contains the document.", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } } ], "query": [ { "description": "Specifies the node or shard the operation should be performed on. Random by default.", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "Boolean) If true, the request is real-time as opposed to near-real-time.", "docId": "realtiime", "name": "realtime", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.", "name": "refresh", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Target the specified primary shard.", "docId": "routing", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#get-routing", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "True or false to return the _source field or not, or a list of fields to return.", "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "SourceConfigParam", "namespace": "_global.search._types" } } }, { "description": "A comma-separated list of source fields to exclude in the response.", "name": "_source_excludes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "A comma-separated list of source fields to include in the response.", "name": "_source_includes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "name": "stored_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionNumber", "namespace": "_types" } } }, { "description": "Specific version type: internal, external, external_gte.", "name": "version_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionType", "namespace": "_types" } } } ], "specLocation": "_global/get_source/SourceRequest.ts#L31-L89" }, { "kind": "response", "body": { "kind": "value", "value": { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.get_source.Response" } } }, "generics": [ { "name": "TDocument", "namespace": "_global.get_source.Response" } ], "name": { "name": "Response", "namespace": "_global.get_source" }, "specLocation": "_global/get_source/SourceResponse.ts#L20-L23" }, { "kind": "interface", "name": { "name": "BaseIndicator", "namespace": "_global.health_report" }, "properties": [ { "name": "status", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndicatorHealthStatus", "namespace": "_global.health_report" } } }, { "name": "symptom", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "impacts", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "Impact", "namespace": "_global.health_report" } } } }, { "name": "diagnosis", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "Diagnosis", "namespace": "_global.health_report" } } } } ], "specLocation": "_global/health_report/types.ts#L44-L49" }, { "kind": "interface", "name": { "name": "DataStreamLifecycleDetails", "namespace": "_global.health_report" }, "properties": [ { "name": "stagnating_backing_indices_count", "required": true, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "total_backing_indices_in_error", "required": true, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "stagnating_backing_indices", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "StagnatingBackingIndices", "namespace": "_global.health_report" } } } } ], "specLocation": "_global/health_report/types.ts#L153-L157" }, { "kind": "interface", "description": "DATA_STREAM_LIFECYCLE", "inherits": { "type": { "name": "BaseIndicator", "namespace": "_global.health_report" } }, "name": { "name": "DataStreamLifecycleIndicator", "namespace": "_global.health_report" }, "properties": [ { "name": "details", "required": false, "type": { "kind": "instance_of", "type": { "name": "DataStreamLifecycleDetails", "namespace": "_global.health_report" } } } ], "specLocation": "_global/health_report/types.ts#L148-L152" }, { "kind": "interface", "name": { "name": "Diagnosis", "namespace": "_global.health_report" }, "properties": [ { "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "action", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "affected_resources", "required": true, "type": { "kind": "instance_of", "type": { "name": "DiagnosisAffectedResources", "namespace": "_global.health_report" } } }, { "name": "cause", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "help_url", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } ], "specLocation": "_global/health_report/types.ts#L51-L57" }, { "kind": "interface", "name": { "name": "DiagnosisAffectedResources", "namespace": "_global.health_report" }, "properties": [ { "name": "indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } }, { "name": "nodes", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "IndicatorNode", "namespace": "_global.health_report" } } } }, { "name": "slm_policies", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "name": "feature_states", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "name": "snapshot_repositories", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } } ], "specLocation": "_global/health_report/types.ts#L59-L65" }, { "kind": "interface", "description": "DISK", "inherits": { "type": { "name": "BaseIndicator", "namespace": "_global.health_report" } }, "name": { "name": "DiskIndicator", "namespace": "_global.health_report" }, "properties": [ { "name": "details", "required": false, "type": { "kind": "instance_of", "type": { "name": "DiskIndicatorDetails", "namespace": "_global.health_report" } } } ], "specLocation": "_global/health_report/types.ts#L124-L128" }, { "kind": "interface", "name": { "name": "DiskIndicatorDetails", "namespace": "_global.health_report" }, "properties": [ { "name": "indices_with_readonly_block", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "nodes_with_enough_disk_space", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "nodes_over_high_watermark", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "nodes_over_flood_stage_watermark", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "nodes_with_unknown_disk_status", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } } ], "specLocation": "_global/health_report/types.ts#L129-L135" }, { "kind": "interface", "description": "FILE_SETTINGS", "inherits": { "type": { "name": "BaseIndicator", "namespace": "_global.health_report" } }, "name": { "name": "FileSettingsIndicator", "namespace": "_global.health_report" }, "properties": [ { "name": "details", "required": false, "type": { "kind": "instance_of", "type": { "name": "FileSettingsIndicatorDetails", "namespace": "_global.health_report" } } } ], "specLocation": "_global/health_report/types.ts#L207-L211" }, { "kind": "interface", "name": { "name": "FileSettingsIndicatorDetails", "namespace": "_global.health_report" }, "properties": [ { "name": "failure_streak", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "most_recent_failure", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } ], "specLocation": "_global/health_report/types.ts#L213-L216" }, { "kind": "interface", "description": "ILM", "inherits": { "type": { "name": "BaseIndicator", "namespace": "_global.health_report" } }, "name": { "name": "IlmIndicator", "namespace": "_global.health_report" }, "properties": [ { "name": "details", "required": false, "type": { "kind": "instance_of", "type": { "name": "IlmIndicatorDetails", "namespace": "_global.health_report" } } } ], "specLocation": "_global/health_report/types.ts#L164-L168" }, { "kind": "interface", "name": { "name": "IlmIndicatorDetails", "namespace": "_global.health_report" }, "properties": [ { "name": "ilm_status", "required": true, "type": { "kind": "instance_of", "type": { "name": "LifecycleOperationMode", "namespace": "_types" } } }, { "name": "policies", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "stagnating_indices", "required": true, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/health_report/types.ts#L169-L173" }, { "kind": "interface", "name": { "name": "Impact", "namespace": "_global.health_report" }, "properties": [ { "name": "description", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "impact_areas", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "ImpactArea", "namespace": "_global.health_report" } } } }, { "name": "severity", "required": true, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/health_report/types.ts#L67-L72" }, { "kind": "enum", "members": [ { "name": "search" }, { "name": "ingest" }, { "name": "backup" }, { "name": "deployment_management" } ], "name": { "name": "ImpactArea", "namespace": "_global.health_report" }, "specLocation": "_global/health_report/types.ts#L74-L79" }, { "kind": "enum", "members": [ { "name": "green" }, { "name": "yellow" }, { "name": "red" }, { "name": "unknown" } ], "name": { "name": "IndicatorHealthStatus", "namespace": "_global.health_report" }, "specLocation": "_global/health_report/types.ts#L25-L30" }, { "kind": "interface", "name": { "name": "IndicatorNode", "namespace": "_global.health_report" }, "properties": [ { "name": "name", "required": true, "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, { "kind": "instance_of", "type": { "name": "null", "namespace": "_builtins" } } ] } }, { "name": "node_id", "required": true, "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, { "kind": "instance_of", "type": { "name": "null", "namespace": "_builtins" } } ] } } ], "specLocation": "_global/health_report/types.ts#L92-L95" }, { "kind": "interface", "name": { "name": "Indicators", "namespace": "_global.health_report" }, "properties": [ { "name": "master_is_stable", "required": false, "type": { "kind": "instance_of", "type": { "name": "MasterIsStableIndicator", "namespace": "_global.health_report" } } }, { "name": "shards_availability", "required": false, "type": { "kind": "instance_of", "type": { "name": "ShardsAvailabilityIndicator", "namespace": "_global.health_report" } } }, { "name": "disk", "required": false, "type": { "kind": "instance_of", "type": { "name": "DiskIndicator", "namespace": "_global.health_report" } } }, { "name": "repository_integrity", "required": false, "type": { "kind": "instance_of", "type": { "name": "RepositoryIntegrityIndicator", "namespace": "_global.health_report" } } }, { "name": "data_stream_lifecycle", "required": false, "type": { "kind": "instance_of", "type": { "name": "DataStreamLifecycleIndicator", "namespace": "_global.health_report" } } }, { "name": "ilm", "required": false, "type": { "kind": "instance_of", "type": { "name": "IlmIndicator", "namespace": "_global.health_report" } } }, { "name": "slm", "required": false, "type": { "kind": "instance_of", "type": { "name": "SlmIndicator", "namespace": "_global.health_report" } } }, { "name": "shards_capacity", "required": false, "type": { "kind": "instance_of", "type": { "name": "ShardsCapacityIndicator", "namespace": "_global.health_report" } } }, { "name": "file_settings", "required": false, "type": { "kind": "instance_of", "type": { "name": "FileSettingsIndicator", "namespace": "_global.health_report" } } } ], "specLocation": "_global/health_report/types.ts#L32-L42" }, { "kind": "interface", "description": "MASTER_IS_STABLE", "inherits": { "type": { "name": "BaseIndicator", "namespace": "_global.health_report" } }, "name": { "name": "MasterIsStableIndicator", "namespace": "_global.health_report" }, "properties": [ { "name": "details", "required": false, "type": { "kind": "instance_of", "type": { "name": "MasterIsStableIndicatorDetails", "namespace": "_global.health_report" } } } ], "specLocation": "_global/health_report/types.ts#L81-L85" }, { "kind": "interface", "name": { "name": "MasterIsStableIndicatorClusterFormationNode", "namespace": "_global.health_report" }, "properties": [ { "name": "name", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "node_id", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "cluster_formation_message", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } ], "specLocation": "_global/health_report/types.ts#L100-L104" }, { "kind": "interface", "name": { "name": "MasterIsStableIndicatorDetails", "namespace": "_global.health_report" }, "properties": [ { "name": "current_master", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndicatorNode", "namespace": "_global.health_report" } } }, { "name": "recent_masters", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "IndicatorNode", "namespace": "_global.health_report" } } } }, { "name": "exception_fetching_history", "required": false, "type": { "kind": "instance_of", "type": { "name": "MasterIsStableIndicatorExceptionFetchingHistory", "namespace": "_global.health_report" } } }, { "name": "cluster_formation", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "MasterIsStableIndicatorClusterFormationNode", "namespace": "_global.health_report" } } } } ], "specLocation": "_global/health_report/types.ts#L86-L91" }, { "kind": "interface", "name": { "name": "MasterIsStableIndicatorExceptionFetchingHistory", "namespace": "_global.health_report" }, "properties": [ { "name": "message", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "stack_trace", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } ], "specLocation": "_global/health_report/types.ts#L96-L99" }, { "kind": "interface", "description": "REPOSITORY_INTEGRITY", "inherits": { "type": { "name": "BaseIndicator", "namespace": "_global.health_report" } }, "name": { "name": "RepositoryIntegrityIndicator", "namespace": "_global.health_report" }, "properties": [ { "name": "details", "required": false, "type": { "kind": "instance_of", "type": { "name": "RepositoryIntegrityIndicatorDetails", "namespace": "_global.health_report" } } } ], "specLocation": "_global/health_report/types.ts#L137-L141" }, { "kind": "interface", "name": { "name": "RepositoryIntegrityIndicatorDetails", "namespace": "_global.health_report" }, "properties": [ { "name": "total_repositories", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "corrupted_repositories", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "corrupted", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } } ], "specLocation": "_global/health_report/types.ts#L142-L146" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "no_body" }, "description": "Returns the health of the cluster.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.health_report" }, "path": [ { "description": "A feature of the cluster, as returned by the top-level health report API.", "name": "feature", "required": false, "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } ] } } ], "query": [ { "description": "Explicit operation timeout.", "name": "timeout", "required": false, "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "Opt-in for more information about the health of the system.", "name": "verbose", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Limit the number of affected resources the health report API returns.", "name": "size", "required": false, "serverDefault": 1000, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/health_report/Request.ts#L24-L52" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "cluster_name", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "indicators", "required": true, "type": { "kind": "instance_of", "type": { "name": "Indicators", "namespace": "_global.health_report" } } }, { "name": "status", "required": false, "type": { "kind": "instance_of", "type": { "name": "IndicatorHealthStatus", "namespace": "_global.health_report" } } } ] }, "name": { "name": "Response", "namespace": "_global.health_report" }, "specLocation": "_global/health_report/Response.ts#L22-L28" }, { "kind": "interface", "description": "SHARDS_AVAILABILITY", "inherits": { "type": { "name": "BaseIndicator", "namespace": "_global.health_report" } }, "name": { "name": "ShardsAvailabilityIndicator", "namespace": "_global.health_report" }, "properties": [ { "name": "details", "required": false, "type": { "kind": "instance_of", "type": { "name": "ShardsAvailabilityIndicatorDetails", "namespace": "_global.health_report" } } } ], "specLocation": "_global/health_report/types.ts#L106-L110" }, { "kind": "interface", "name": { "name": "ShardsAvailabilityIndicatorDetails", "namespace": "_global.health_report" }, "properties": [ { "name": "creating_primaries", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "creating_replicas", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "initializing_primaries", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "initializing_replicas", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "restarting_primaries", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "restarting_replicas", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "started_primaries", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "started_replicas", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "unassigned_primaries", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "unassigned_replicas", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } } ], "specLocation": "_global/health_report/types.ts#L111-L122" }, { "kind": "interface", "description": "SHARDS_CAPACITY", "inherits": { "type": { "name": "BaseIndicator", "namespace": "_global.health_report" } }, "name": { "name": "ShardsCapacityIndicator", "namespace": "_global.health_report" }, "properties": [ { "name": "details", "required": false, "type": { "kind": "instance_of", "type": { "name": "ShardsCapacityIndicatorDetails", "namespace": "_global.health_report" } } } ], "specLocation": "_global/health_report/types.ts#L191-L195" }, { "kind": "interface", "name": { "name": "ShardsCapacityIndicatorDetails", "namespace": "_global.health_report" }, "properties": [ { "name": "data", "required": true, "type": { "kind": "instance_of", "type": { "name": "ShardsCapacityIndicatorTierDetail", "namespace": "_global.health_report" } } }, { "name": "frozen", "required": true, "type": { "kind": "instance_of", "type": { "name": "ShardsCapacityIndicatorTierDetail", "namespace": "_global.health_report" } } } ], "specLocation": "_global/health_report/types.ts#L197-L200" }, { "kind": "interface", "name": { "name": "ShardsCapacityIndicatorTierDetail", "namespace": "_global.health_report" }, "properties": [ { "name": "max_shards_in_cluster", "required": true, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "current_used_shards", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/health_report/types.ts#L202-L205" }, { "kind": "interface", "description": "SLM", "inherits": { "type": { "name": "BaseIndicator", "namespace": "_global.health_report" } }, "name": { "name": "SlmIndicator", "namespace": "_global.health_report" }, "properties": [ { "name": "details", "required": false, "type": { "kind": "instance_of", "type": { "name": "SlmIndicatorDetails", "namespace": "_global.health_report" } } } ], "specLocation": "_global/health_report/types.ts#L175-L179" }, { "kind": "interface", "name": { "name": "SlmIndicatorDetails", "namespace": "_global.health_report" }, "properties": [ { "name": "slm_status", "required": true, "type": { "kind": "instance_of", "type": { "name": "LifecycleOperationMode", "namespace": "_types" } } }, { "name": "policies", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "unhealthy_policies", "required": false, "type": { "kind": "instance_of", "type": { "name": "SlmIndicatorUnhealthyPolicies", "namespace": "_global.health_report" } } } ], "specLocation": "_global/health_report/types.ts#L180-L184" }, { "kind": "interface", "name": { "name": "SlmIndicatorUnhealthyPolicies", "namespace": "_global.health_report" }, "properties": [ { "name": "count", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "invocations_since_last_success", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } } } ], "specLocation": "_global/health_report/types.ts#L186-L189" }, { "kind": "interface", "name": { "name": "StagnatingBackingIndices", "namespace": "_global.health_report" }, "properties": [ { "name": "index_name", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } }, { "name": "first_occurrence_timestamp", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "retry_count", "required": true, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/health_report/types.ts#L158-L162" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "value", "codegenName": "document", "value": { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.index.Request" } } }, "description": "Index a document.\nAdds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "generics": [ { "name": "TDocument", "namespace": "_global.index.Request" } ], "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.index" }, "path": [ { "description": "Unique identifier for the document.", "name": "id", "required": false, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "Name of the data stream or index to target.", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } } ], "query": [ { "description": "Only perform the operation if the document has this primary term.", "name": "if_primary_term", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "Only perform the operation if the document has this sequence number.", "name": "if_seq_no", "required": false, "type": { "kind": "instance_of", "type": { "name": "SequenceNumber", "namespace": "_types" } } }, { "description": "Set to create to only index the document if it does not already exist (put if absent).\nIf a document with the specified `_id` already exists, the indexing operation will fail.\nSame as using the `/_create` endpoint.\nValid values: `index`, `create`.\nIf document id is specified, it defaults to `index`.\nOtherwise, it defaults to `create`.", "name": "op_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "OpType", "namespace": "_types" } } }, { "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", "name": "pipeline", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", "name": "refresh", "required": false, "type": { "kind": "instance_of", "type": { "name": "Refresh", "namespace": "_types" } } }, { "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.", "name": "timeout", "required": false, "serverDefault": "1m", "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionNumber", "namespace": "_types" } } }, { "description": "Specific version type: `external`, `external_gte`.", "name": "version_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionType", "namespace": "_types" } } }, { "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "name": "wait_for_active_shards", "required": false, "serverDefault": "1", "type": { "kind": "instance_of", "type": { "name": "WaitForActiveShards", "namespace": "_types" } } }, { "description": "If `true`, the destination must be an index alias.", "name": "require_alias", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/index/IndexRequest.ts#L35-L119" }, { "kind": "response", "body": { "kind": "value", "value": { "kind": "instance_of", "type": { "name": "WriteResponseBase", "namespace": "_types" } } }, "name": { "name": "Response", "namespace": "_global.index" }, "specLocation": "_global/index/IndexResponse.ts#L22-L24" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "no_body" }, "description": "Get cluster info.\nReturns basic information about the cluster.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.info" }, "path": [], "query": [], "specLocation": "_global/info/RootNodeInfoRequest.ts#L22-L29" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "cluster_name", "required": true, "type": { "kind": "instance_of", "type": { "name": "Name", "namespace": "_types" } } }, { "name": "cluster_uuid", "required": true, "type": { "kind": "instance_of", "type": { "name": "Uuid", "namespace": "_types" } } }, { "name": "name", "required": true, "type": { "kind": "instance_of", "type": { "name": "Name", "namespace": "_types" } } }, { "name": "tagline", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "version", "required": true, "type": { "kind": "instance_of", "type": { "name": "ElasticsearchVersionInfo", "namespace": "_types" } } } ] }, "name": { "name": "Response", "namespace": "_global.info" }, "specLocation": "_global/info/RootNodeInfoResponse.ts#L23-L31" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.", "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "SourceConfig", "namespace": "_global.search._types" } } }, { "description": "The request returns doc values for field names matching these patterns\nin the hits.fields property of the response. Accepts wildcard (*) patterns.", "name": "docvalue_fields", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "FieldAndFormat", "namespace": "_types.query_dsl" } } } }, { "description": "List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.", "name": "stored_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "The request returns values for field names matching these patterns\nin the hits.fields property of the response. Accepts wildcard (*) patterns.", "name": "fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "availability": { "serverless": {}, "stack": { "since": "8.2.0" } }, "description": "Query to filter the documents that can match. The kNN search will return the top\n`k` documents that also match this filter. The value can be a single query or a\nlist of queries. If `filter` isn't provided, all documents are allowed to match.", "name": "filter", "required": false, "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "QueryContainer", "namespace": "_types.query_dsl" } }, { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "QueryContainer", "namespace": "_types.query_dsl" } } } ] } }, { "description": "kNN query to execute", "extDocId": "query-dsl-knn-query", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-knn-query.html", "name": "knn", "required": true, "type": { "kind": "instance_of", "type": { "name": "Query", "namespace": "_global.knn_search._types" } } } ] }, "deprecation": { "description": "The kNN search API has been replaced by the `knn` option in the search API.", "version": "8.4.0" }, "description": "Run a knn search.\n\nNOTE: The kNN search API has been replaced by the `knn` option in the search API.\n\nPerform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents.\nGiven a query vector, the API finds the k closest vectors and returns those documents as search hits.\n\nElasticsearch uses the HNSW algorithm to support efficient kNN search.\nLike most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed.\nThis means the results returned are not always the true k closest neighbors.\n\nThe kNN search API supports restricting the search using a filter.\nThe search will return the top k documents that also match the filter query.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.knn_search" }, "path": [ { "description": "A comma-separated list of index names to search;\nuse `_all` or to perform the operation on all indices", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } } ], "query": [ { "description": "A comma-separated list of specific routing values", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } } ], "specLocation": "_global/knn_search/KnnSearchRequest.ts#L26-L96" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "description": "Milliseconds it took Elasticsearch to execute the request.", "name": "took", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "If true, the request timed out before completion;\nreturned results may be partial or empty.", "name": "timed_out", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Contains a count of shards used for the request.", "name": "_shards", "required": true, "type": { "kind": "instance_of", "type": { "name": "ShardStatistics", "namespace": "_types" } } }, { "description": "Contains returned documents and metadata.", "name": "hits", "required": true, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.knn_search.Response" } } ], "type": { "name": "HitsMetadata", "namespace": "_global.search._types" } } }, { "description": "Contains field values for the documents. These fields\nmust be specified in the request using the `fields` parameter.", "name": "fields", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } }, { "description": "Highest returned document score. This value is null for requests\nthat do not sort by score.", "name": "max_score", "required": false, "type": { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } } } ] }, "generics": [ { "name": "TDocument", "namespace": "_global.knn_search.Response" } ], "name": { "name": "Response", "namespace": "_global.knn_search" }, "specLocation": "_global/knn_search/KnnSearchResponse.ts#L26-L54" }, { "kind": "interface", "name": { "name": "Query", "namespace": "_global.knn_search._types" }, "properties": [ { "description": "The name of the vector field to search against", "name": "field", "required": true, "type": { "kind": "instance_of", "type": { "name": "Field", "namespace": "_types" } } }, { "description": "The query vector", "name": "query_vector", "required": true, "type": { "kind": "instance_of", "type": { "name": "QueryVector", "namespace": "_types" } } }, { "description": "The final number of nearest neighbors to return as top hits", "name": "k", "required": true, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "The number of nearest neighbor candidates to consider per shard", "name": "num_candidates", "required": true, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/knn_search/_types/Knn.ts#L24-L33" }, { "kind": "interface", "name": { "name": "MultiGetError", "namespace": "_global.mget" }, "properties": [ { "name": "error", "required": true, "type": { "kind": "instance_of", "type": { "name": "ErrorCause", "namespace": "_types" } } }, { "name": "_id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "name": "_index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } } ], "specLocation": "_global/mget/types.ts#L62-L66" }, { "kind": "interface", "name": { "name": "Operation", "namespace": "_global.mget" }, "properties": [ { "description": "The unique document ID.", "name": "_id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "The index that contains the document.", "name": "_index", "required": false, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } }, { "description": "The key for the primary shard the document resides on. Required if routing is used during indexing.", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "If `false`, excludes all _source fields.", "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "SourceConfig", "namespace": "_global.search._types" } } }, { "description": "The stored fields you want to retrieve.", "name": "stored_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "name": "version", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionNumber", "namespace": "_types" } } }, { "name": "version_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionType", "namespace": "_types" } } } ], "specLocation": "_global/mget/types.ts#L32-L55" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "description": "The documents you want to retrieve. Required if no index is specified in the request URI.", "name": "docs", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "Operation", "namespace": "_global.mget" } } } }, { "description": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.", "name": "ids", "required": false, "type": { "kind": "instance_of", "type": { "name": "Ids", "namespace": "_types" } } } ] }, "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.mget" }, "path": [ { "description": "Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.", "name": "index", "required": false, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } } ], "query": [ { "availability": { "stack": { "featureFlag": "es.index_mode_feature_flag_registered", "since": "8.4.0", "visibility": "feature_flag" } }, "description": "Should this request force synthetic _source?\nUse this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.\nFetches with this enabled will be slower the enabling synthetic source natively in the index.", "name": "force_synthetic_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Specifies the node or shard the operation should be performed on. Random by default.", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If `true`, the request is real-time as opposed to near-real-time.", "docId": "realtime", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime", "name": "realtime", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, the request refreshes relevant shards before retrieving documents.", "name": "refresh", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "True or false to return the `_source` field or not, or a list of fields to return.", "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "SourceConfigParam", "namespace": "_global.search._types" } } }, { "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.", "docId": "mapping-source-field", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-source-field.html", "name": "_source_excludes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "docId": "mapping-source-field", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-source-field.html", "name": "_source_includes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "If `true`, retrieves the document fields stored in the index rather than the document `_source`.", "name": "stored_fields", "required": false, "serverDefault": "false", "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } } ], "specLocation": "_global/mget/MultiGetRequest.ts#L25-L104" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "docs", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.mget.Response" } } ], "type": { "name": "ResponseItem", "namespace": "_global.mget" } } } } ] }, "generics": [ { "name": "TDocument", "namespace": "_global.mget.Response" } ], "name": { "name": "Response", "namespace": "_global.mget" }, "specLocation": "_global/mget/MultiGetResponse.ts#L22-L26" }, { "kind": "type_alias", "codegenNames": [ "result", "failure" ], "generics": [ { "name": "TDocument", "namespace": "_global.mget.ResponseItem" } ], "name": { "name": "ResponseItem", "namespace": "_global.mget" }, "specLocation": "_global/mget/types.ts#L57-L60", "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.mget.ResponseItem" } } ], "type": { "name": "GetResult", "namespace": "_global.get" } }, { "kind": "instance_of", "type": { "name": "MultiGetError", "namespace": "_global.mget" } } ] } }, { "kind": "interface", "generics": [ { "name": "TDocument", "namespace": "_global.msearch.MultiSearchItem" } ], "inherits": { "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.msearch.MultiSearchItem" } } ], "type": { "name": "ResponseBody", "namespace": "_global.search" } }, "name": { "name": "MultiSearchItem", "namespace": "_global.msearch" }, "properties": [ { "name": "status", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/msearch/types.ts#L216-L219" }, { "kind": "interface", "generics": [ { "name": "TDocument", "namespace": "_global.msearch.MultiSearchResult" } ], "name": { "name": "MultiSearchResult", "namespace": "_global.msearch" }, "properties": [ { "name": "took", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "responses", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.msearch.MultiSearchResult" } } ], "type": { "name": "ResponseItem", "namespace": "_global.msearch" } } } } ], "specLocation": "_global/msearch/types.ts#L206-L209" }, { "kind": "interface", "name": { "name": "MultisearchBody", "namespace": "_global.msearch" }, "properties": [ { "aliases": [ "aggs" ], "extDocId": "search-aggregations", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations.html", "name": "aggregations", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "AggregationContainer", "namespace": "_types.aggregations" } } } }, { "name": "collapse", "required": false, "type": { "kind": "instance_of", "type": { "name": "FieldCollapse", "namespace": "_global.search._types" } } }, { "description": "Defines the search definition using the Query DSL.", "name": "query", "required": false, "type": { "kind": "instance_of", "type": { "name": "QueryContainer", "namespace": "_types.query_dsl" } } }, { "description": "If true, returns detailed information about score computation as part of a hit.", "name": "explain", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Configuration of search extensions defined by Elasticsearch plugins.", "name": "ext", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } }, { "description": "List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.", "name": "stored_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "Array of wildcard (*) patterns. The request returns doc values for field\nnames matching these patterns in the hits.fields property of the response.", "name": "docvalue_fields", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "FieldAndFormat", "namespace": "_types.query_dsl" } } } }, { "availability": { "serverless": {}, "stack": { "since": "8.4.0" } }, "description": "Defines the approximate kNN search to run.", "name": "knn", "required": false, "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "KnnSearch", "namespace": "_types" } }, { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "KnnSearch", "namespace": "_types" } } } ] } }, { "description": "Starting document offset. By default, you cannot page through more than 10,000\nhits using the from and size parameters. To page through more hits, use the\nsearch_after parameter.", "name": "from", "required": false, "serverDefault": 0, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "highlight", "required": false, "type": { "kind": "instance_of", "type": { "name": "Highlight", "namespace": "_global.search._types" } } }, { "description": "Boosts the _score of documents from specified indices.", "name": "indices_boost", "required": false, "type": { "kind": "array_of", "value": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } } } } }, { "description": "Minimum _score for matching documents. Documents with a lower _score are\nnot included in the search results.", "name": "min_score", "required": false, "type": { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } } }, { "name": "post_filter", "required": false, "type": { "kind": "instance_of", "type": { "name": "QueryContainer", "namespace": "_types.query_dsl" } } }, { "name": "profile", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "rescore", "required": false, "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "Rescore", "namespace": "_global.search._types" } }, { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "Rescore", "namespace": "_global.search._types" } } } ] } }, { "description": "Retrieve a script evaluation (based on different fields) for each hit.", "name": "script_fields", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "ScriptField", "namespace": "_types" } } } }, { "name": "search_after", "required": false, "type": { "kind": "instance_of", "type": { "name": "SortResults", "namespace": "_types" } } }, { "description": "The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.", "name": "size", "required": false, "serverDefault": 10, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "docId": "sort-search-results", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html", "name": "sort", "required": false, "type": { "kind": "instance_of", "type": { "name": "Sort", "namespace": "_types" } } }, { "description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.", "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "SourceConfig", "namespace": "_global.search._types" } } }, { "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.", "name": "fields", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "FieldAndFormat", "namespace": "_types.query_dsl" } } } }, { "description": "Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.", "name": "terminate_after", "required": false, "serverDefault": 0, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.", "name": "stats", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "description": "Specifies the period of time to wait for a response from each shard. If no response\nis received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", "name": "timeout", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If true, calculate and return document scores, even if the scores are not used for sorting.", "name": "track_scores", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.", "name": "track_total_hits", "required": false, "type": { "kind": "instance_of", "type": { "name": "TrackHits", "namespace": "_global.search._types" } } }, { "description": "If true, returns document version as part of a hit.", "name": "version", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", "name": "runtime_mappings", "required": false, "type": { "kind": "instance_of", "type": { "name": "RuntimeFields", "namespace": "_types.mapping" } } }, { "description": "If true, returns sequence number and primary term of the last modification\nof each hit. See Optimistic concurrency control.", "name": "seq_no_primary_term", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an in the request path.", "name": "pit", "required": false, "type": { "kind": "instance_of", "type": { "name": "PointInTimeReference", "namespace": "_global.search._types" } } }, { "name": "suggest", "required": false, "type": { "kind": "instance_of", "type": { "name": "Suggester", "namespace": "_global.search._types" } } } ], "specLocation": "_global/msearch/types.ts#L70-L204" }, { "kind": "interface", "description": "Contains parameters used to limit or change the subsequent search body request.", "name": { "name": "MultisearchHeader", "namespace": "_global.msearch" }, "properties": [ { "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { "name": "ExpandWildcards", "namespace": "_types" } } }, { "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "index", "required": false, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } }, { "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "request_cache", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "name": "search_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "SearchType", "namespace": "_types" } } }, { "name": "ccs_minimize_roundtrips", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "allow_partial_search_results", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "ignore_throttled", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/msearch/types.ts#L52-L67" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "value", "codegenName": "searches", "value": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "RequestItem", "namespace": "_global.msearch" } } } }, "description": "Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.msearch" }, "path": [ { "description": "Comma-separated list of data streams, indices, and index aliases to search.", "name": "index", "required": false, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } } ], "query": [ { "description": "If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.", "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", "docId": "ccs-network-delays", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-cross-cluster-search.html#ccs-network-delays", "name": "ccs_minimize_roundtrips", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.", "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { "name": "ExpandWildcards", "namespace": "_types" } } }, { "description": "If true, concrete, expanded or aliased indices are ignored when frozen.", "name": "ignore_throttled", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If true, missing or closed indices are not included in the response.", "name": "ignore_unavailable", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Indicates whether hit.matched_queries should be rendered as a map that includes\nthe name of the matched query associated with its score (true)\nor as an array containing the name of the matched queries (false)\nThis functionality reruns each named query on every hit in a search response.\nTypically, this adds a small overhead to a request.\nHowever, using computationally expensive named queries on a large number of hits may add significant overhead.", "name": "include_named_queries_score", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Maximum number of concurrent searches the multi search API can execute.", "name": "max_concurrent_searches", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "Maximum number of concurrent shard requests that each sub-search request executes per node.", "name": "max_concurrent_shard_requests", "required": false, "serverDefault": 5, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.", "name": "pre_filter_shard_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.", "name": "rest_total_hits_as_int", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Custom routing value used to route search operations to a specific shard.", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "Indicates whether global term and document frequencies should be used when scoring returned documents.", "name": "search_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "SearchType", "namespace": "_types" } } }, { "description": "Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.", "name": "typed_keys", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/msearch/MultiSearchRequest.ts#L25-L124" }, { "kind": "type_alias", "codegenNames": [ "header", "body" ], "name": { "name": "RequestItem", "namespace": "_global.msearch" }, "specLocation": "_global/msearch/types.ts#L47-L50", "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "MultisearchHeader", "namespace": "_global.msearch" } }, { "kind": "instance_of", "type": { "name": "MultisearchBody", "namespace": "_global.msearch" } } ] } }, { "kind": "response", "body": { "kind": "value", "value": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.msearch.Response" } } ], "type": { "name": "MultiSearchResult", "namespace": "_global.msearch" } } }, "generics": [ { "name": "TDocument", "namespace": "_global.msearch.Response" } ], "name": { "name": "Response", "namespace": "_global.msearch" }, "specLocation": "_global/msearch/MultiSearchResponse.ts#L25-L27" }, { "kind": "type_alias", "codegenNames": [ "result", "failure" ], "generics": [ { "name": "TDocument", "namespace": "_global.msearch.ResponseItem" } ], "name": { "name": "ResponseItem", "namespace": "_global.msearch" }, "specLocation": "_global/msearch/types.ts#L211-L214", "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.msearch.ResponseItem" } } ], "type": { "name": "MultiSearchItem", "namespace": "_global.msearch" } }, { "kind": "instance_of", "type": { "name": "ErrorResponseBase", "namespace": "_types" } } ] } }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "value", "codegenName": "search_templates", "value": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "RequestItem", "namespace": "_global.msearch_template" } } } }, "description": "Run multiple templated searches.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.msearch_template" }, "path": [ { "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*`.", "name": "index", "required": false, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } } ], "query": [ { "description": "If `true`, network round-trips are minimized for cross-cluster search requests.", "name": "ccs_minimize_roundtrips", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Maximum number of concurrent searches the API can run.", "name": "max_concurrent_searches", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "The type of the search operation.\nAvailable options: `query_then_fetch`, `dfs_query_then_fetch`.", "name": "search_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "SearchType", "namespace": "_types" } } }, { "description": "If `true`, the response returns `hits.total` as an integer.\nIf `false`, it returns `hits.total` as an object.", "name": "rest_total_hits_as_int", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, the response prefixes aggregation and suggester names with their respective types.", "name": "typed_keys", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/msearch_template/MultiSearchTemplateRequest.ts#L25-L72" }, { "kind": "type_alias", "codegenNames": [ "header", "body" ], "name": { "name": "RequestItem", "namespace": "_global.msearch_template" }, "specLocation": "_global/msearch_template/types.ts#L25-L26", "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "MultisearchHeader", "namespace": "_global.msearch" } }, { "kind": "instance_of", "type": { "name": "TemplateConfig", "namespace": "_global.msearch_template" } } ] } }, { "kind": "response", "body": { "kind": "value", "value": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.msearch_template.Response" } } ], "type": { "name": "MultiSearchResult", "namespace": "_global.msearch" } } }, "generics": [ { "name": "TDocument", "namespace": "_global.msearch_template.Response" } ], "name": { "name": "Response", "namespace": "_global.msearch_template" }, "specLocation": "_global/msearch_template/MultiSearchTemplateResponse.ts#L22-L24" }, { "kind": "interface", "name": { "name": "TemplateConfig", "namespace": "_global.msearch_template" }, "properties": [ { "description": "If `true`, returns detailed information about score calculation as part of each hit.", "name": "explain", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "ID of the search template to use. If no source is specified,\nthis parameter is required.", "name": "id", "required": false, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.", "name": "params", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } }, { "description": "If `true`, the query execution is profiled.", "name": "profile", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. Also supports Mustache variables. If no id is specified, this\nparameter is required.", "name": "source", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } ], "specLocation": "_global/msearch_template/types.ts#L28-L54" }, { "kind": "interface", "name": { "name": "Operation", "namespace": "_global.mtermvectors" }, "properties": [ { "description": "The ID of the document.", "name": "_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "The index of the document.", "name": "_index", "required": false, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } }, { "description": "An artificial document (a document not present in the index) for which you want to retrieve term vectors.", "name": "doc", "required": false, "type": { "kind": "user_defined_value" } }, { "description": "Comma-separated list or wildcard expressions of fields to include in the statistics.\nUsed as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", "name": "fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.", "name": "field_statistics", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Filter terms based on their tf-idf scores.", "name": "filter", "required": false, "type": { "kind": "instance_of", "type": { "name": "Filter", "namespace": "_global.termvectors" } } }, { "description": "If `true`, the response includes term offsets.", "name": "offsets", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, the response includes term payloads.", "name": "payloads", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, the response includes term positions.", "name": "positions", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "If true, the response includes term frequency and document frequency.", "name": "term_statistics", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, returns the document version as part of a hit.", "name": "version", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionNumber", "namespace": "_types" } } }, { "description": "Specific version type.", "name": "version_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionType", "namespace": "_types" } } } ], "specLocation": "_global/mtermvectors/types.ts#L35-L94" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "description": "Array of existing or artificial documents.", "name": "docs", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "Operation", "namespace": "_global.mtermvectors" } } } }, { "description": "Simplified syntax to specify documents by their ID if they're in the same index.", "name": "ids", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } } } ] }, "description": "Get multiple term vectors.\n\nYou can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.mtermvectors" }, "path": [ { "description": "Name of the index that contains the documents.", "name": "index", "required": false, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } } ], "query": [ { "description": "A comma-separated list of documents ids. You must define ids as parameter or set \"ids\" or \"docs\" in the request body", "name": "ids", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } } }, { "description": "Comma-separated list or wildcard expressions of fields to include in the statistics.\nUsed as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", "name": "fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.", "name": "field_statistics", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, the response includes term offsets.", "name": "offsets", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, the response includes term payloads.", "name": "payloads", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, the response includes term positions.", "name": "positions", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If true, the request is real-time as opposed to near-real-time.", "docId": "realtime", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime", "name": "realtime", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "If true, the response includes term frequency and document frequency.", "name": "term_statistics", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, returns the document version as part of a hit.", "name": "version", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionNumber", "namespace": "_types" } } }, { "description": "Specific version type.", "name": "version_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionType", "namespace": "_types" } } } ], "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L116" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "docs", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "TermVectorsResult", "namespace": "_global.mtermvectors" } } } } ] }, "name": { "name": "Response", "namespace": "_global.mtermvectors" }, "specLocation": "_global/mtermvectors/MultiTermVectorsResponse.ts#L22-L24" }, { "kind": "interface", "name": { "name": "TermVectorsResult", "namespace": "_global.mtermvectors" }, "properties": [ { "name": "_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "name": "_index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } }, { "name": "_version", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionNumber", "namespace": "_types" } } }, { "name": "took", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "found", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "term_vectors", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "Field", "namespace": "_types" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "TermVector", "namespace": "_global.termvectors" } } } }, { "name": "error", "required": false, "type": { "kind": "instance_of", "type": { "name": "ErrorCause", "namespace": "_types" } } } ], "specLocation": "_global/mtermvectors/types.ts#L96-L104" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "description": "Allows to filter indices if the provided query rewrites to `match_none` on every shard.", "name": "index_filter", "required": false, "type": { "kind": "instance_of", "type": { "name": "QueryContainer", "namespace": "_types.query_dsl" } } } ] }, "description": "Open a point in time.\n\nA search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.open_point_in_time" }, "path": [ { "description": "A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } } ], "query": [ { "description": "Extends the time to live of the corresponding point in time.", "name": "keep_alive", "required": true, "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "If `false`, the request returns an error if it targets a missing or closed index.", "name": "ignore_unavailable", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.", "name": "expand_wildcards", "required": false, "serverDefault": "open", "type": { "kind": "instance_of", "type": { "name": "ExpandWildcards", "namespace": "_types" } } }, { "description": "If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception.\nIf `true`, the point in time will contain all the shards that are available at the time of the request.", "name": "allow_partial_search_results", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/open_point_in_time/OpenPointInTimeRequest.ts#L25-L87" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "description": "Shards used to create the PIT", "name": "_shards", "required": true, "type": { "kind": "instance_of", "type": { "name": "ShardStatistics", "namespace": "_types" } } }, { "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } } ] }, "name": { "name": "Response", "namespace": "_global.open_point_in_time" }, "specLocation": "_global/open_point_in_time/OpenPointInTimeResponse.ts#L23-L29" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "no_body" }, "description": "Ping the cluster.\nReturns whether the cluster is running.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.ping" }, "path": [], "query": [], "specLocation": "_global/ping/PingRequest.ts#L22-L30" }, { "kind": "response", "body": { "kind": "no_body" }, "name": { "name": "Response", "namespace": "_global.ping" }, "specLocation": "_global/ping/PingResponse.ts#L22-L24" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "description": "Contains the script or search template, its parameters, and its language.", "name": "script", "required": true, "type": { "kind": "instance_of", "type": { "name": "StoredScript", "namespace": "_types" } } } ] }, "description": "Create or update a script or search template.\nCreates or updates a stored script or search template.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.put_script" }, "path": [ { "description": "Identifier for the stored script or search template.\nMust be unique within the cluster.", "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "Context in which the script or search template should run.\nTo prevent errors, the API immediately compiles the script or template in this context.", "name": "context", "required": false, "type": { "kind": "instance_of", "type": { "name": "Name", "namespace": "_types" } } } ], "query": [ { "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "master_timeout", "required": false, "serverDefault": "30s", "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "serverDefault": "30s", "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } } ], "specLocation": "_global/put_script/PutScriptRequest.ts#L25-L66" }, { "kind": "response", "body": { "kind": "value", "value": { "kind": "instance_of", "type": { "name": "AcknowledgedResponseBase", "namespace": "_types" } } }, "name": { "name": "Response", "namespace": "_global.put_script" }, "specLocation": "_global/put_script/PutScriptResponse.ts#L22-L24" }, { "kind": "interface", "name": { "name": "DocumentRating", "namespace": "_global.rank_eval" }, "properties": [ { "description": "The document ID.", "name": "_id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "The document’s index. For data streams, this should be the document’s backing index.", "name": "_index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } }, { "description": "The document’s relevance with regard to this search request.", "name": "rating", "required": true, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/rank_eval/types.ts#L119-L126" }, { "kind": "interface", "name": { "name": "RankEvalHit", "namespace": "_global.rank_eval" }, "properties": [ { "name": "_id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "name": "_index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } }, { "name": "_score", "required": true, "type": { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } } } ], "specLocation": "_global/rank_eval/types.ts#L144-L148" }, { "kind": "interface", "name": { "name": "RankEvalHitItem", "namespace": "_global.rank_eval" }, "properties": [ { "name": "hit", "required": true, "type": { "kind": "instance_of", "type": { "name": "RankEvalHit", "namespace": "_global.rank_eval" } } }, { "name": "rating", "required": false, "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } }, { "kind": "instance_of", "type": { "name": "null", "namespace": "_builtins" } } ] } } ], "specLocation": "_global/rank_eval/types.ts#L139-L142" }, { "kind": "interface", "name": { "name": "RankEvalMetric", "namespace": "_global.rank_eval" }, "properties": [ { "name": "precision", "required": false, "type": { "kind": "instance_of", "type": { "name": "RankEvalMetricPrecision", "namespace": "_global.rank_eval" } } }, { "name": "recall", "required": false, "type": { "kind": "instance_of", "type": { "name": "RankEvalMetricRecall", "namespace": "_global.rank_eval" } } }, { "name": "mean_reciprocal_rank", "required": false, "type": { "kind": "instance_of", "type": { "name": "RankEvalMetricMeanReciprocalRank", "namespace": "_global.rank_eval" } } }, { "name": "dcg", "required": false, "type": { "kind": "instance_of", "type": { "name": "RankEvalMetricDiscountedCumulativeGain", "namespace": "_global.rank_eval" } } }, { "name": "expected_reciprocal_rank", "required": false, "type": { "kind": "instance_of", "type": { "name": "RankEvalMetricExpectedReciprocalRank", "namespace": "_global.rank_eval" } } } ], "specLocation": "_global/rank_eval/types.ts#L90-L96" }, { "kind": "interface", "name": { "name": "RankEvalMetricBase", "namespace": "_global.rank_eval" }, "properties": [ { "description": "Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query.", "name": "k", "required": false, "serverDefault": 10, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/rank_eval/types.ts#L26-L32" }, { "kind": "interface", "name": { "name": "RankEvalMetricDetail", "namespace": "_global.rank_eval" }, "properties": [ { "description": "The metric_score in the details section shows the contribution of this query to the global quality metric score", "name": "metric_score", "required": true, "type": { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } } }, { "description": "The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn’t have a ratings value. This can be used to ask the user to supply ratings for these documents", "name": "unrated_docs", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "UnratedDocument", "namespace": "_global.rank_eval" } } } }, { "description": "The hits section shows a grouping of the search results with their supplied ratings", "name": "hits", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "RankEvalHitItem", "namespace": "_global.rank_eval" } } } }, { "description": "The metric_details give additional information about the calculated quality metric (e.g. how many of the retrieved documents were relevant). The content varies for each metric but allows for better interpretation of the results", "name": "metric_details", "required": true, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } } } ], "specLocation": "_global/rank_eval/types.ts#L128-L137" }, { "kind": "interface", "description": "Discounted cumulative gain (DCG)", "docId": "dcg", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_discounted_cumulative_gain_dcg", "inherits": { "type": { "name": "RankEvalMetricBase", "namespace": "_global.rank_eval" } }, "name": { "name": "RankEvalMetricDiscountedCumulativeGain", "namespace": "_global.rank_eval" }, "properties": [ { "description": "If set to true, this metric will calculate the Normalized DCG.", "docUrl": "https://en.wikipedia.org/wiki/Discounted_cumulative_gain#Normalized_DCG", "name": "normalize", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/rank_eval/types.ts#L66-L77" }, { "kind": "interface", "description": "Expected Reciprocal Rank (ERR)", "docId": "expected-reciprocal", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_expected_reciprocal_rank_err", "inherits": { "type": { "name": "RankEvalMetricBase", "namespace": "_global.rank_eval" } }, "name": { "name": "RankEvalMetricExpectedReciprocalRank", "namespace": "_global.rank_eval" }, "properties": [ { "description": "The highest relevance grade used in the user-supplied relevance judgments.", "name": "maximum_relevance", "required": true, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/rank_eval/types.ts#L79-L88" }, { "kind": "interface", "description": "Mean Reciprocal Rank", "docId": "mean-reciprocal", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_mean_reciprocal_rank", "inherits": { "type": { "name": "RankEvalMetricRatingTreshold", "namespace": "_global.rank_eval" } }, "name": { "name": "RankEvalMetricMeanReciprocalRank", "namespace": "_global.rank_eval" }, "properties": [], "specLocation": "_global/rank_eval/types.ts#L60-L64" }, { "kind": "interface", "description": "Precision at K (P@k)", "docId": "k-precision", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#k-precision", "inherits": { "type": { "name": "RankEvalMetricRatingTreshold", "namespace": "_global.rank_eval" } }, "name": { "name": "RankEvalMetricPrecision", "namespace": "_global.rank_eval" }, "properties": [ { "description": "Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant.", "name": "ignore_unlabeled", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/rank_eval/types.ts#L42-L52" }, { "kind": "interface", "inherits": { "type": { "name": "RankEvalMetricBase", "namespace": "_global.rank_eval" } }, "name": { "name": "RankEvalMetricRatingTreshold", "namespace": "_global.rank_eval" }, "properties": [ { "description": "Sets the rating threshold above which documents are considered to be \"relevant\".", "name": "relevant_rating_threshold", "required": false, "serverDefault": 1, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/rank_eval/types.ts#L34-L40" }, { "kind": "interface", "description": "Recall at K (R@k)", "docId": "k-recall", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#k-recall", "inherits": { "type": { "name": "RankEvalMetricRatingTreshold", "namespace": "_global.rank_eval" } }, "name": { "name": "RankEvalMetricRecall", "namespace": "_global.rank_eval" }, "properties": [], "specLocation": "_global/rank_eval/types.ts#L54-L58" }, { "kind": "interface", "name": { "name": "RankEvalQuery", "namespace": "_global.rank_eval" }, "properties": [ { "name": "query", "required": true, "type": { "kind": "instance_of", "type": { "name": "QueryContainer", "namespace": "_types.query_dsl" } } }, { "name": "size", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "shortcutProperty": "query", "specLocation": "_global/rank_eval/types.ts#L111-L117" }, { "kind": "interface", "name": { "name": "RankEvalRequestItem", "namespace": "_global.rank_eval" }, "properties": [ { "description": "The search request’s ID, used to group result details later.", "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "The query being evaluated.", "name": "request", "required": false, "type": { "kind": "instance_of", "type": { "name": "RankEvalQuery", "namespace": "_global.rank_eval" } } }, { "description": "List of document ratings", "name": "ratings", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "DocumentRating", "namespace": "_global.rank_eval" } } } }, { "description": "The search template Id", "name": "template_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "description": "The search template parameters.", "name": "params", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } } ], "specLocation": "_global/rank_eval/types.ts#L98-L109" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "description": "A set of typical search requests, together with their provided ratings.", "name": "requests", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "RankEvalRequestItem", "namespace": "_global.rank_eval" } } } }, { "description": "Definition of the evaluation metric to calculate.", "name": "metric", "required": false, "type": { "kind": "instance_of", "type": { "name": "RankEvalMetric", "namespace": "_global.rank_eval" } } } ] }, "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.rank_eval" }, "path": [ { "description": "Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (`*`) expressions are supported.\nTo target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.", "name": "index", "required": false, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } } ], "query": [ { "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", "name": "allow_no_indices", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { "name": "ExpandWildcards", "namespace": "_types" } } }, { "description": "If `true`, missing or closed indices are not included in the response.", "name": "ignore_unavailable", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Search operation type", "name": "search_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } ], "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L64" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "description": "The overall evaluation quality calculated by the defined metric", "name": "metric_score", "required": true, "type": { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } } }, { "description": "The details section contains one entry for every query in the original requests section, keyed by the search request id", "name": "details", "required": true, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "RankEvalMetricDetail", "namespace": "_global.rank_eval" } } } }, { "name": "failures", "required": true, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } } ] }, "name": { "name": "Response", "namespace": "_global.rank_eval" }, "specLocation": "_global/rank_eval/RankEvalResponse.ts#L26-L34" }, { "kind": "interface", "name": { "name": "UnratedDocument", "namespace": "_global.rank_eval" }, "properties": [ { "name": "_id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "name": "_index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } } ], "specLocation": "_global/rank_eval/types.ts#L150-L153" }, { "kind": "interface", "name": { "name": "Destination", "namespace": "_global.reindex" }, "properties": [ { "description": "The name of the data stream, index, or index alias you are copying to.", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } }, { "description": "Set to `create` to only index documents that do not already exist.\nImportant: To reindex to a data stream destination, this argument must be `create`.", "name": "op_type", "required": false, "serverDefault": "index", "type": { "kind": "instance_of", "type": { "name": "OpType", "namespace": "_types" } } }, { "description": "The name of the pipeline to use.", "name": "pipeline", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "By default, a document's routing is preserved unless it’s changed by the script.\nSet to `discard` to set routing to `null`, or `=value` to route using the specified `value`.", "name": "routing", "required": false, "serverDefault": "keep", "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "The versioning to use for the indexing operation.", "name": "version_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionType", "namespace": "_types" } } } ], "specLocation": "_global/reindex/types.ts#L39-L64" }, { "kind": "interface", "name": { "name": "RemoteSource", "namespace": "_global.reindex" }, "properties": [ { "description": "The remote connection timeout.\nDefaults to 30 seconds.", "name": "connect_timeout", "required": false, "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "An object containing the headers of the request.", "name": "headers", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "description": "The URL for the remote instance of Elasticsearch that you want to index from.", "name": "host", "required": true, "type": { "kind": "instance_of", "type": { "name": "Host", "namespace": "_types" } } }, { "description": "The username to use for authentication with the remote host.", "name": "username", "required": false, "type": { "kind": "instance_of", "type": { "name": "Username", "namespace": "_types" } } }, { "description": "The password to use for authentication with the remote host.", "name": "password", "required": false, "type": { "kind": "instance_of", "type": { "name": "Password", "namespace": "_types" } } }, { "description": "The remote socket read timeout. Defaults to 30 seconds.", "name": "socket_timeout", "required": false, "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } } ], "specLocation": "_global/reindex/types.ts#L99-L125" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "description": "Set to proceed to continue reindexing even if there are conflicts.", "name": "conflicts", "required": false, "serverDefault": "abort", "type": { "kind": "instance_of", "type": { "name": "Conflicts", "namespace": "_types" } } }, { "description": "The destination you are copying to.", "name": "dest", "required": true, "type": { "kind": "instance_of", "type": { "name": "Destination", "namespace": "_global.reindex" } } }, { "description": "The maximum number of documents to reindex.", "name": "max_docs", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "The script to run to update the document source or metadata when reindexing.", "name": "script", "required": false, "type": { "kind": "instance_of", "type": { "name": "Script", "namespace": "_types" } } }, { "name": "size", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "The source you are copying from.", "name": "source", "required": true, "type": { "kind": "instance_of", "type": { "name": "Source", "namespace": "_global.reindex" } } } ] }, "description": "Reindex documents.\nCopies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.reindex" }, "path": [], "query": [ { "description": "If `true`, the request refreshes affected shards to make this operation visible to search.", "name": "refresh", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "The throttle for this request in sub-requests per second.\nDefaults to no throttle.", "name": "requests_per_second", "required": false, "serverDefault": -1, "type": { "kind": "instance_of", "type": { "name": "float", "namespace": "_types" } } }, { "description": "Specifies how long a consistent view of the index should be maintained for scrolled search.", "name": "scroll", "required": false, "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "The number of slices this task should be divided into.\nDefaults to 1 slice, meaning the task isn’t sliced into subtasks.", "name": "slices", "required": false, "serverDefault": "1", "type": { "kind": "instance_of", "type": { "name": "Slices", "namespace": "_types" } } }, { "description": "Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.", "name": "timeout", "required": false, "serverDefault": "1m", "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "name": "wait_for_active_shards", "required": false, "serverDefault": "1", "type": { "kind": "instance_of", "type": { "name": "WaitForActiveShards", "namespace": "_types" } } }, { "description": "If `true`, the request blocks until the operation is complete.", "name": "wait_for_completion", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, the destination must be an index alias.", "name": "require_alias", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/reindex/ReindexRequest.ts#L27-L104" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "batches", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "created", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "deleted", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "failures", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "BulkIndexByScrollFailure", "namespace": "_types" } } } }, { "name": "noops", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "retries", "required": false, "type": { "kind": "instance_of", "type": { "name": "Retries", "namespace": "_types" } } }, { "name": "requests_per_second", "required": false, "type": { "kind": "instance_of", "type": { "name": "float", "namespace": "_types" } } }, { "name": "slice_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "task", "required": false, "type": { "kind": "instance_of", "type": { "name": "TaskId", "namespace": "_types" } } }, { "name": "throttled_millis", "required": false, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "UnitMillis", "namespace": "_types" } } ], "type": { "name": "EpochTime", "namespace": "_types" } } }, { "name": "throttled_until_millis", "required": false, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "UnitMillis", "namespace": "_types" } } ], "type": { "name": "EpochTime", "namespace": "_types" } } }, { "name": "timed_out", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "took", "required": false, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "UnitMillis", "namespace": "_types" } } ], "type": { "name": "DurationValue", "namespace": "_types" } } }, { "name": "total", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "updated", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "version_conflicts", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } } ] }, "name": { "name": "Response", "namespace": "_global.reindex" }, "specLocation": "_global/reindex/ReindexResponse.ts#L26-L45" }, { "kind": "interface", "name": { "name": "Source", "namespace": "_global.reindex" }, "properties": [ { "description": "The name of the data stream, index, or alias you are copying from.\nAccepts a comma-separated list to reindex from multiple sources.", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } }, { "description": "Specifies the documents to reindex using the Query DSL.", "name": "query", "required": false, "type": { "kind": "instance_of", "type": { "name": "QueryContainer", "namespace": "_types.query_dsl" } } }, { "description": "A remote instance of Elasticsearch that you want to index from.", "name": "remote", "required": false, "type": { "kind": "instance_of", "type": { "name": "RemoteSource", "namespace": "_global.reindex" } } }, { "description": "The number of documents to index per batch.\nUse when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB.", "name": "size", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "Slice the reindex request manually using the provided slice ID and total number of slices.", "name": "slice", "required": false, "type": { "kind": "instance_of", "type": { "name": "SlicedScroll", "namespace": "_types" } } }, { "name": "sort", "required": false, "type": { "kind": "instance_of", "type": { "name": "Sort", "namespace": "_types" } } }, { "codegenName": "source_fields", "description": "If `true` reindexes all source fields.\nSet to a list to reindex select fields.", "name": "_source", "required": false, "serverDefault": "true", "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "name": "runtime_mappings", "required": false, "type": { "kind": "instance_of", "type": { "name": "RuntimeFields", "namespace": "_types.mapping" } } } ], "specLocation": "_global/reindex/types.ts#L66-L97" }, { "kind": "interface", "inherits": { "type": { "name": "BaseNode", "namespace": "_spec_utils" } }, "name": { "name": "ReindexNode", "namespace": "_global.reindex_rethrottle" }, "properties": [ { "name": "tasks", "required": true, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "TaskId", "namespace": "_types" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "ReindexTask", "namespace": "_global.reindex_rethrottle" } } } } ], "specLocation": "_global/reindex_rethrottle/types.ts#L33-L35" }, { "kind": "interface", "name": { "name": "ReindexStatus", "namespace": "_global.reindex_rethrottle" }, "properties": [ { "description": "The number of scroll responses pulled back by the reindex.", "name": "batches", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "The number of documents that were successfully created.", "name": "created", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "The number of documents that were successfully deleted.", "name": "deleted", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`.", "name": "noops", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "The number of requests per second effectively executed during the reindex.", "name": "requests_per_second", "required": true, "type": { "kind": "instance_of", "type": { "name": "float", "namespace": "_types" } } }, { "description": "The number of retries attempted by reindex. `bulk` is the number of bulk actions retried and `search` is the number of search actions retried.", "name": "retries", "required": true, "type": { "kind": "instance_of", "type": { "name": "Retries", "namespace": "_types" } } }, { "name": "throttled", "required": false, "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "Number of milliseconds the request slept to conform to `requests_per_second`.", "name": "throttled_millis", "required": true, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "UnitMillis", "namespace": "_types" } } ], "type": { "name": "DurationValue", "namespace": "_types" } } }, { "name": "throttled_until", "required": false, "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "This field should always be equal to zero in a `_reindex` response.\nIt only has meaning when using the Task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be executed again in order to conform to `requests_per_second`.", "name": "throttled_until_millis", "required": true, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "UnitMillis", "namespace": "_types" } } ], "type": { "name": "DurationValue", "namespace": "_types" } } }, { "description": "The number of documents that were successfully processed.", "name": "total", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it.", "name": "updated", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "The number of version conflicts that reindex hits.", "name": "version_conflicts", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } } ], "specLocation": "_global/reindex_rethrottle/types.ts#L37-L85" }, { "kind": "interface", "name": { "name": "ReindexTask", "namespace": "_global.reindex_rethrottle" }, "properties": [ { "name": "action", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "cancellable", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "description", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "node", "required": true, "type": { "kind": "instance_of", "type": { "name": "Name", "namespace": "_types" } } }, { "name": "running_time_in_nanos", "required": true, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "UnitNanos", "namespace": "_types" } } ], "type": { "name": "DurationValue", "namespace": "_types" } } }, { "name": "start_time_in_millis", "required": true, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "UnitMillis", "namespace": "_types" } } ], "type": { "name": "EpochTime", "namespace": "_types" } } }, { "name": "status", "required": true, "type": { "kind": "instance_of", "type": { "name": "ReindexStatus", "namespace": "_global.reindex_rethrottle" } } }, { "name": "type", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "headers", "required": true, "type": { "kind": "instance_of", "type": { "name": "HttpHeaders", "namespace": "_types" } } } ], "specLocation": "_global/reindex_rethrottle/types.ts#L87-L98" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "no_body" }, "description": "Throttle a reindex operation.\n\nChange the number of requests per second for a particular reindex operation.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.reindex_rethrottle" }, "path": [ { "description": "Identifier for the task.", "name": "task_id", "required": true, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } } ], "query": [ { "description": "The throttle for this request in sub-requests per second.", "name": "requests_per_second", "required": false, "type": { "kind": "instance_of", "type": { "name": "float", "namespace": "_types" } } } ], "specLocation": "_global/reindex_rethrottle/ReindexRethrottleRequest.ts#L24-L46" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "nodes", "required": true, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "ReindexNode", "namespace": "_global.reindex_rethrottle" } } } } ] }, "name": { "name": "Response", "namespace": "_global.reindex_rethrottle" }, "specLocation": "_global/reindex_rethrottle/ReindexRethrottleResponse.ts#L23-L25" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "name": "file", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.", "name": "params", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } }, { "description": "An inline search template.\nSupports the same parameters as the search API's request body.\nThese parameters also support Mustache variables.\nIf no `id` or `` is specified, this parameter is required.", "name": "source", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } ] }, "description": "Render a search template.\n\nRender a search template as a search request body.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.render_search_template" }, "path": [ { "description": "ID of the search template to render.\nIf no `source` is specified, this or the `id` request body parameter is required.", "name": "id", "required": false, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } } ], "query": [], "specLocation": "_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L58" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "template_output", "required": true, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } } ] }, "name": { "name": "Response", "namespace": "_global.render_search_template" }, "specLocation": "_global/render_search_template/RenderSearchTemplateResponse.ts#L23-L25" }, { "kind": "interface", "name": { "name": "PainlessContextSetup", "namespace": "_global.scripts_painless_execute" }, "properties": [ { "description": "Document that’s temporarily indexed in-memory and accessible from the script.", "name": "document", "required": true, "type": { "kind": "user_defined_value" } }, { "description": "Index containing a mapping that’s compatible with the indexed document.\nYou may specify a remote index by prefixing the index with the remote cluster alias.", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } }, { "description": "Use this parameter to specify a query for computing a score.", "name": "query", "required": false, "type": { "kind": "instance_of", "type": { "name": "QueryContainer", "namespace": "_types.query_dsl" } } } ], "specLocation": "_global/scripts_painless_execute/types.ts#L25-L39" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "description": "The context that the script should run in.", "name": "context", "required": false, "serverDefault": "painless_test", "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "Additional parameters for the `context`.", "name": "context_setup", "required": false, "type": { "kind": "instance_of", "type": { "name": "PainlessContextSetup", "namespace": "_global.scripts_painless_execute" } } }, { "description": "The Painless script to execute.", "name": "script", "required": false, "type": { "kind": "instance_of", "type": { "name": "Script", "namespace": "_types" } } } ] }, "description": "Run a script.\nRuns a script and returns a result.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.scripts_painless_execute" }, "path": [], "query": [], "specLocation": "_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts#L24-L48" }, { "kind": "response", "body": { "kind": "properties", "properties": [ { "name": "result", "required": true, "type": { "kind": "instance_of", "type": { "name": "TResult", "namespace": "_global.scripts_painless_execute.Response" } } } ] }, "generics": [ { "name": "TResult", "namespace": "_global.scripts_painless_execute.Response" } ], "name": { "name": "Response", "namespace": "_global.scripts_painless_execute" }, "specLocation": "_global/scripts_painless_execute/ExecutePainlessScriptResponse.ts#L20-L24" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "description": "Period to retain the search context for scrolling.", "docId": "scroll-search-results", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results", "name": "scroll", "required": false, "serverDefault": "1d", "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "Scroll ID of the search.", "name": "scroll_id", "required": true, "type": { "kind": "instance_of", "type": { "name": "ScrollId", "namespace": "_types" } } } ] }, "description": "Run a scrolling search.\n\nIMPORTANT: 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 the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.scroll" }, "path": [ { "deprecation": { "description": "", "version": "7.0.0" }, "description": "The scroll ID", "name": "scroll_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "ScrollId", "namespace": "_types" } } } ], "query": [ { "description": "Period to retain the search context for scrolling.", "docId": "scroll-search-results", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results", "name": "scroll", "required": false, "serverDefault": "1d", "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "deprecation": { "description": "", "version": "7.0.0" }, "description": "The scroll ID for scrolled search", "name": "scroll_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "ScrollId", "namespace": "_types" } } }, { "description": "If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object.", "name": "rest_total_hits_as_int", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/scroll/ScrollRequest.ts#L24-L75" }, { "kind": "response", "body": { "kind": "value", "value": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.scroll.Response" } } ], "type": { "name": "ResponseBody", "namespace": "_global.search" } } }, "generics": [ { "name": "TDocument", "namespace": "_global.scroll.Response" } ], "name": { "name": "Response", "namespace": "_global.scroll" }, "specLocation": "_global/scroll/ScrollResponse.ts#L22-L24" }, { "kind": "request", "attachedBehaviors": [ "CommonQueryParameters" ], "body": { "kind": "properties", "properties": [ { "aliases": [ "aggs" ], "description": "Defines the aggregations that are run as part of the search request.", "name": "aggregations", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "AggregationContainer", "namespace": "_types.aggregations" } } } }, { "description": "Collapses search results the values of the specified field.", "name": "collapse", "required": false, "type": { "kind": "instance_of", "type": { "name": "FieldCollapse", "namespace": "_global.search._types" } } }, { "description": "If true, returns detailed information about score computation as part of a hit.", "name": "explain", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Configuration of search extensions defined by Elasticsearch plugins.", "name": "ext", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } }, { "description": "Starting document offset.\nNeeds to be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", "name": "from", "required": false, "serverDefault": 0, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.", "name": "highlight", "required": false, "type": { "kind": "instance_of", "type": { "name": "Highlight", "namespace": "_global.search._types" } } }, { "description": "Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.", "name": "track_total_hits", "required": false, "serverDefault": "10000", "type": { "kind": "instance_of", "type": { "name": "TrackHits", "namespace": "_global.search._types" } } }, { "description": "Boosts the _score of documents from specified indices.", "name": "indices_boost", "required": false, "type": { "kind": "array_of", "value": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } } } } }, { "description": "Array of wildcard (`*`) patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", "name": "docvalue_fields", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "FieldAndFormat", "namespace": "_types.query_dsl" } } } }, { "availability": { "serverless": {}, "stack": { "since": "8.4.0" } }, "description": "Defines the approximate kNN search to run.", "name": "knn", "required": false, "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "KnnSearch", "namespace": "_types" } }, { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "KnnSearch", "namespace": "_types" } } } ] } }, { "availability": { "stack": { "since": "8.8.0" } }, "description": "Defines the Reciprocal Rank Fusion (RRF) to use.", "name": "rank", "required": false, "type": { "kind": "instance_of", "type": { "name": "RankContainer", "namespace": "_types" } } }, { "description": "Minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in the search results.", "name": "min_score", "required": false, "type": { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } } }, { "description": "Use the `post_filter` parameter to filter search results.\nThe search hits are filtered after the aggregations are calculated.\nA post filter has no impact on the aggregation results.", "name": "post_filter", "required": false, "type": { "kind": "instance_of", "type": { "name": "QueryContainer", "namespace": "_types.query_dsl" } } }, { "description": "Set to `true` to return detailed timing information about the execution of individual components in a search request.\nNOTE: This is a debugging tool and adds significant overhead to search execution.", "name": "profile", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Defines the search definition using the Query DSL.", "name": "query", "required": false, "type": { "kind": "instance_of", "type": { "name": "QueryContainer", "namespace": "_types.query_dsl" } } }, { "description": "Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.", "name": "rescore", "required": false, "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "Rescore", "namespace": "_global.search._types" } }, { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "Rescore", "namespace": "_global.search._types" } } } ] } }, { "availability": { "serverless": { "stability": "stable" }, "stack": { "since": "8.14.0", "stability": "stable" } }, "description": "A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn.", "name": "retriever", "required": false, "type": { "kind": "instance_of", "type": { "name": "RetrieverContainer", "namespace": "_types" } } }, { "description": "Retrieve a script evaluation (based on different fields) for each hit.", "name": "script_fields", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "ScriptField", "namespace": "_types" } } } }, { "description": "Used to retrieve the next page of hits using a set of sort values from the previous page.", "name": "search_after", "required": false, "type": { "kind": "instance_of", "type": { "name": "SortResults", "namespace": "_types" } } }, { "description": "The number of hits to return.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", "name": "size", "required": false, "serverDefault": 10, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "Can be used to split a scrolled search into multiple slices that can be consumed independently.", "name": "slice", "required": false, "type": { "kind": "instance_of", "type": { "name": "SlicedScroll", "namespace": "_types" } } }, { "description": "A comma-separated list of : pairs.", "docId": "sort-search-results", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html", "name": "sort", "required": false, "type": { "kind": "instance_of", "type": { "name": "Sort", "namespace": "_types" } } }, { "description": "Indicates which source fields are returned for matching documents.\nThese fields are returned in the hits._source property of the search response.", "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "SourceConfig", "namespace": "_global.search._types" } } }, { "description": "Array of wildcard (`*`) patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.", "name": "fields", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "FieldAndFormat", "namespace": "_types.query_dsl" } } } }, { "description": "Defines a suggester that provides similar looking terms based on a provided text.", "name": "suggest", "required": false, "type": { "kind": "instance_of", "type": { "name": "Suggester", "namespace": "_global.search._types" } } }, { "description": "Maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\nUse with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.\nIf set to `0` (default), the query does not terminate early.", "name": "terminate_after", "required": false, "serverDefault": 0, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "Specifies the period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", "name": "timeout", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If true, calculate and return document scores, even if the scores are not used for sorting.", "name": "track_scores", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If true, returns document version as part of a hit.", "name": "version", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, returns sequence number and primary term of the last modification of each hit.", "name": "seq_no_primary_term", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "List of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", "name": "stored_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "Limits the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `` in the request path.", "name": "pit", "required": false, "type": { "kind": "instance_of", "type": { "name": "PointInTimeReference", "namespace": "_global.search._types" } } }, { "description": "Defines one or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.", "name": "runtime_mappings", "required": false, "type": { "kind": "instance_of", "type": { "name": "RuntimeFields", "namespace": "_types.mapping" } } }, { "description": "Stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API.", "name": "stats", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } } ] }, "description": "Run a search.\n\nGet search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, "name": { "name": "Request", "namespace": "_global.search" }, "path": [ { "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.", "name": "index", "required": false, "type": { "kind": "instance_of", "type": { "name": "Indices", "namespace": "_types" } } } ], "query": [ { "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", "name": "allow_no_indices", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results.", "name": "allow_partial_search_results", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Analyzer to use for the query string.\nThis parameter can only be used when the q query string parameter is specified.", "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "If true, wildcard and prefix queries are analyzed.\nThis parameter can only be used when the q query string parameter is specified.", "name": "analyze_wildcard", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "The number of shard results that should be reduced at once on the coordinating node.\nThis value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", "name": "batched_reduce_size", "required": false, "serverDefault": 512, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests.", "docId": "ccs-network-delays", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-cross-cluster-search.html#ccs-network-delays", "name": "ccs_minimize_roundtrips", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "The default operator for query string query: AND or OR.\nThis parameter can only be used when the `q` query string parameter is specified.", "name": "default_operator", "required": false, "serverDefault": "OR", "type": { "kind": "instance_of", "type": { "name": "Operator", "namespace": "_types.query_dsl" } } }, { "description": "Field to use as default where no field prefix is given in the query string.\nThis parameter can only be used when the q query string parameter is specified.", "name": "df", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "A comma-separated list of fields to return as the docvalue representation for each hit.", "name": "docvalue_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { "name": "ExpandWildcards", "namespace": "_types" } } }, { "description": "If `true`, returns detailed information about score computation as part of a hit.", "name": "explain", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, concrete, expanded or aliased indices will be ignored when frozen.", "name": "ignore_throttled", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `false`, the request returns an error if it targets a missing or closed index.", "name": "ignore_unavailable", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Indicates whether hit.matched_queries should be rendered as a map that includes\nthe name of the matched query associated with its score (true)\nor as an array containing the name of the matched queries (false)\nThis functionality reruns each named query on every hit in a search response.\nTypically, this adds a small overhead to a request.\nHowever, using computationally expensive named queries on a large number of hits may add significant overhead.", "name": "include_named_queries_score", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can only be used when the `q` query string parameter is specified.", "name": "lenient", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Defines the number of concurrent shard requests per node this search executes concurrently.\nThis value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", "name": "max_concurrent_shard_requests", "required": false, "serverDefault": 5, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "Nodes and shards used for the search.\nBy default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:\n`_only_local` to run the search only on shards on the local node;\n`_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method;\n`_only_nodes:,` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method;\n`_prefer_nodes:,` to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method;\n`_shards:,` to run the search only on the specified shards;\n`` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order.", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold.\nThis filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint).\nWhen unspecified, the pre-filter phase is executed if any of these conditions is met:\nthe request targets more than 128 shards;\nthe request targets one or more read-only index;\nthe primary sort of the query targets an indexed field.", "name": "pre_filter_shard_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "If `true`, the caching of search results is enabled for requests where `size` is `0`.\nDefaults to index level settings.", "name": "request_cache", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "description": "Period to retain the search context for scrolling. See Scroll search results.\nBy default, this value cannot exceed `1d` (24 hours).\nYou can change this limit using the `search.max_keep_alive` cluster-level setting.", "docId": "scroll-search-results", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results", "name": "scroll", "required": false, "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "How distributed term frequencies are calculated for relevance scoring.", "name": "search_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "SearchType", "namespace": "_types" } } }, { "description": "Specific `tag` of the request for logging and statistical purposes.", "name": "stats", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", "name": "stored_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "Specifies which field to use for suggestions.", "name": "suggest_field", "required": false, "type": { "kind": "instance_of", "type": { "name": "Field", "namespace": "_types" } } }, { "description": "Specifies the suggest mode.\nThis parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified.", "name": "suggest_mode", "required": false, "serverDefault": "missing", "type": { "kind": "instance_of", "type": { "name": "SuggestMode", "namespace": "_types" } } }, { "description": "Number of suggestions to return.\nThis parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified.", "name": "suggest_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "The source text for which the suggestions should be returned.\nThis parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified.", "name": "suggest_text", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "Maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\nUse with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.\nIf set to `0` (default), the query does not terminate early.", "name": "terminate_after", "required": false, "serverDefault": 0, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "description": "Specifies the period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "description": "Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.", "name": "track_total_hits", "required": false, "serverDefault": "10000", "type": { "kind": "instance_of", "type": { "name": "TrackHits", "namespace": "_global.search._types" } } }, { "description": "If `true`, calculate and return document scores, even if the scores are not used for sorting.", "name": "track_scores", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, aggregation and suggester names are be prefixed by their respective types in the response.", "name": "typed_keys", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response.", "name": "rest_total_hits_as_int", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "If `true`, returns document version as part of a hit.", "name": "version", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Indicates which source fields are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nValid values are:\n`true` to return the entire document source;\n`false` to not return the document source;\n`` to return the source fields that are specified as a comma-separated list (supports wildcard (`*`) patterns).", "name": "_source", "required": false, "serverDefault": "true", "type": { "kind": "instance_of", "type": { "name": "SourceConfigParam", "namespace": "_global.search._types" } } }, { "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "name": "_source_excludes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "name": "_source_includes", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } }, { "description": "If `true`, returns sequence number and primary term of the last modification of each hit.", "name": "seq_no_primary_term", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Query in the Lucene query string syntax using query parameter search.\nQuery parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.", "name": "q", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "Defines the number of hits to return.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", "name": "size", "required": false, "serverDefault": 10, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "Starting document offset.\nNeeds to be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", "name": "from", "required": false, "serverDefault": 0, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "A comma-separated list of : pairs.", "docId": "sort-search-results", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html", "name": "sort", "required": false, "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } ] } }, { "availability": { "stack": { "featureFlag": "es.index_mode_feature_flag_registered", "since": "8.4.0", "visibility": "feature_flag" } }, "description": "Should this request force synthetic _source?\nUse this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.\nFetches with this enabled will be slower the enabling synthetic source natively in the index.", "name": "force_synthetic_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/search/SearchRequest.ts#L53-L525" }, { "kind": "response", "body": { "kind": "value", "value": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.search.Response" } } ], "type": { "name": "ResponseBody", "namespace": "_global.search" } } }, "generics": [ { "name": "TDocument", "namespace": "_global.search.Response" } ], "name": { "name": "Response", "namespace": "_global.search" }, "specLocation": "_global/search/SearchResponse.ts#L34-L36" }, { "kind": "interface", "generics": [ { "name": "TDocument", "namespace": "_global.search.ResponseBody" } ], "name": { "name": "ResponseBody", "namespace": "_global.search" }, "properties": [ { "name": "took", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "timed_out", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "_shards", "required": true, "type": { "kind": "instance_of", "type": { "name": "ShardStatistics", "namespace": "_types" } } }, { "name": "hits", "required": true, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.search.ResponseBody" } } ], "type": { "name": "HitsMetadata", "namespace": "_global.search._types" } } }, { "name": "aggregations", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "AggregateName", "namespace": "_types" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "Aggregate", "namespace": "_types.aggregations" } } } }, { "name": "_clusters", "required": false, "type": { "kind": "instance_of", "type": { "name": "ClusterStatistics", "namespace": "_types" } } }, { "name": "fields", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } }, { "name": "max_score", "required": false, "type": { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } } }, { "name": "num_reduce_phases", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "profile", "required": false, "type": { "kind": "instance_of", "type": { "name": "Profile", "namespace": "_global.search._types" } } }, { "name": "pit_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "name": "_scroll_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "ScrollId", "namespace": "_types" } } }, { "name": "suggest", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "SuggestionName", "namespace": "_types" } }, "singleKey": false, "value": { "kind": "array_of", "value": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.search.ResponseBody" } } ], "type": { "name": "Suggest", "namespace": "_global.search._types" } } } } }, { "name": "terminated_early", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/search/SearchResponse.ts#L38-L54" }, { "kind": "interface", "name": { "name": "AggregationBreakdown", "namespace": "_global.search._types" }, "properties": [ { "name": "build_aggregation", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "build_aggregation_count", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "build_leaf_collector", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "build_leaf_collector_count", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "collect", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "collect_count", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "initialize", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "initialize_count", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "post_collection", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "post_collection_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "reduce", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "reduce_count", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } } ], "specLocation": "_global/search/_types/profile.ts#L26-L39" }, { "kind": "interface", "name": { "name": "AggregationProfile", "namespace": "_global.search._types" }, "properties": [ { "name": "breakdown", "required": true, "type": { "kind": "instance_of", "type": { "name": "AggregationBreakdown", "namespace": "_global.search._types" } } }, { "name": "description", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "time_in_nanos", "required": true, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "UnitNanos", "namespace": "_types" } } ], "type": { "name": "DurationValue", "namespace": "_types" } } }, { "name": "type", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "debug", "required": false, "type": { "kind": "instance_of", "type": { "name": "AggregationProfileDebug", "namespace": "_global.search._types" } } }, { "name": "children", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "AggregationProfile", "namespace": "_global.search._types" } } } } ], "specLocation": "_global/search/_types/profile.ts#L85-L92" }, { "kind": "interface", "name": { "name": "AggregationProfileDebug", "namespace": "_global.search._types" }, "properties": [ { "name": "segments_with_multi_valued_ords", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "collection_strategy", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "segments_with_single_valued_ords", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "total_buckets", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "built_buckets", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "result_strategy", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "has_filter", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "delegate", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "delegate_debug", "required": false, "type": { "kind": "instance_of", "type": { "name": "AggregationProfileDebug", "namespace": "_global.search._types" } } }, { "name": "chars_fetched", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "extract_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "extract_ns", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "values_fetched", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "collect_analyzed_ns", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "collect_analyzed_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "surviving_buckets", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "ordinals_collectors_used", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "ordinals_collectors_overhead_too_high", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "string_hashing_collectors_used", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "numeric_collectors_used", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "empty_collectors_used", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "deferred_aggregators", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "name": "segments_with_doc_count_field", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "segments_with_deleted_docs", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "filters", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "AggregationProfileDelegateDebugFilter", "namespace": "_global.search._types" } } } }, { "name": "segments_counted", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "segments_collected", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "map_reducer", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "brute_force_used", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "dynamic_pruning_attempted", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "dynamic_pruning_used", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "skipped_due_to_no_data", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/search/_types/profile.ts#L42-L76" }, { "kind": "interface", "name": { "name": "AggregationProfileDelegateDebugFilter", "namespace": "_global.search._types" }, "properties": [ { "name": "results_from_metadata", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "query", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "specialized_for", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "segments_counted_in_constant_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/search/_types/profile.ts#L78-L83" }, { "kind": "enum", "members": [ { "description": "Use the characters specified by `boundary_chars` as highlighting boundaries.\nThe `boundary_max_scan` setting controls how far to scan for boundary characters.\nOnly valid for the `fvh` highlighter.", "name": "chars" }, { "description": "Break highlighted fragments at the next sentence boundary, as determined by Java’s `BreakIterator`.\nYou can specify the locale to use with `boundary_scanner_locale`.\nWhen used with the `unified` highlighter, the `sentence` scanner splits sentences bigger than `fragment_size` at the first word boundary next to fragment_size.\nYou can set `fragment_size` to `0` to never split any sentence.", "name": "sentence" }, { "description": "Break highlighted fragments at the next word boundary, as determined by Java’s `BreakIterator`.\nYou can specify the locale to use with `boundary_scanner_locale`.", "name": "word" } ], "name": { "name": "BoundaryScanner", "namespace": "_global.search._types" }, "specLocation": "_global/search/_types/highlighting.ts#L26-L45" }, { "kind": "interface", "name": { "name": "Collector", "namespace": "_global.search._types" }, "properties": [ { "name": "name", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "reason", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "time_in_nanos", "required": true, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "UnitNanos", "namespace": "_types" } } ], "type": { "name": "DurationValue", "namespace": "_types" } } }, { "name": "children", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "Collector", "namespace": "_global.search._types" } } } } ], "specLocation": "_global/search/_types/profile.ts#L94-L99" }, { "kind": "interface", "name": { "name": "CompletionContext", "namespace": "_global.search._types" }, "properties": [ { "description": "The factor by which the score of the suggestion should be boosted.\nThe score is computed by multiplying the boost with the suggestion weight.", "name": "boost", "required": false, "serverDefault": 1, "type": { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } } }, { "description": "The value of the category to filter/boost on.", "name": "context", "required": true, "type": { "kind": "instance_of", "type": { "name": "Context", "namespace": "_global.search._types" } } }, { "description": "An array of precision values at which neighboring geohashes should be taken into account.\nPrecision value can be a distance value (`5m`, `10km`, etc.) or a raw geohash precision (`1`..`12`).\nDefaults to generating neighbors for index time precision level.", "name": "neighbours", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "GeoHashPrecision", "namespace": "_types" } } } }, { "description": "The precision of the geohash to encode the query geo point.\nCan be specified as a distance value (`5m`, `10km`, etc.), or as a raw geohash precision (`1`..`12`).\nDefaults to index time precision level.", "name": "precision", "required": false, "type": { "kind": "instance_of", "type": { "name": "GeoHashPrecision", "namespace": "_types" } } }, { "description": "Whether the category value should be treated as a prefix or not.", "name": "prefix", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "shortcutProperty": "context", "specLocation": "_global/search/_types/suggester.ts#L235-L264" }, { "kind": "interface", "generics": [ { "name": "TDocument", "namespace": "_global.search._types.CompletionSuggest" } ], "inherits": { "type": { "name": "SuggestBase", "namespace": "_global.search._types" } }, "name": { "name": "CompletionSuggest", "namespace": "_global.search._types" }, "properties": [ { "name": "options", "required": true, "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.search._types.CompletionSuggest" } } ], "type": { "name": "CompletionSuggestOption", "namespace": "_global.search._types" } }, { "kind": "array_of", "value": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.search._types.CompletionSuggest" } } ], "type": { "name": "CompletionSuggestOption", "namespace": "_global.search._types" } } } ] } } ], "specLocation": "_global/search/_types/suggester.ts#L48-L55", "variantName": "completion" }, { "kind": "interface", "generics": [ { "name": "TDocument", "namespace": "_global.search._types.CompletionSuggestOption" } ], "name": { "name": "CompletionSuggestOption", "namespace": "_global.search._types" }, "properties": [ { "name": "collate_match", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "name": "contexts", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "Context", "namespace": "_global.search._types" } } } } }, { "name": "fields", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } }, { "name": "_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "_index", "required": false, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } }, { "name": "_routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "Routing", "namespace": "_types" } } }, { "name": "_score", "required": false, "type": { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } } }, { "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.search._types.CompletionSuggestOption" } } }, { "name": "text", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "score", "required": false, "type": { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } } } ], "specLocation": "_global/search/_types/suggester.ts#L73-L84" }, { "kind": "interface", "inherits": { "type": { "name": "SuggesterBase", "namespace": "_global.search._types" } }, "name": { "name": "CompletionSuggester", "namespace": "_global.search._types" }, "properties": [ { "description": "A value, geo point object, or a geo hash string to filter or boost the suggestion on.", "name": "contexts", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "Field", "namespace": "_types" } }, "singleKey": false, "value": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "CompletionContext", "namespace": "_global.search._types" } }, { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "CompletionContext", "namespace": "_global.search._types" } } } ] } } }, { "description": "Enables fuzziness, meaning you can have a typo in your search and still get results back.", "name": "fuzzy", "required": false, "type": { "kind": "instance_of", "type": { "name": "SuggestFuzziness", "namespace": "_global.search._types" } } }, { "description": "A regex query that expresses a prefix as a regular expression.", "name": "regex", "required": false, "type": { "kind": "instance_of", "type": { "name": "RegexOptions", "namespace": "_global.search._types" } } }, { "description": "Whether duplicate suggestions should be filtered out.", "name": "skip_duplicates", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } } ], "specLocation": "_global/search/_types/suggester.ts#L163-L181" }, { "kind": "type_alias", "codegenNames": [ "category", "location" ], "description": "Text or location that we want similar documents for or a lookup to a document's field for the text.", "docId": "document-input-parameters", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html#_document_input_parameters", "name": { "name": "Context", "namespace": "_global.search._types" }, "specLocation": "_global/search/_types/suggester.ts#L228-L233", "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, { "kind": "instance_of", "type": { "name": "GeoLocation", "namespace": "_types" } } ] } }, { "kind": "interface", "name": { "name": "DfsKnnProfile", "namespace": "_global.search._types" }, "properties": [ { "name": "vector_operations_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "query", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "KnnQueryProfileResult", "namespace": "_global.search._types" } } } }, { "name": "rewrite_time", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "collector", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "KnnCollectorResult", "namespace": "_global.search._types" } } } } ], "specLocation": "_global/search/_types/profile.ts#L181-L186" }, { "kind": "interface", "name": { "name": "DfsProfile", "namespace": "_global.search._types" }, "properties": [ { "name": "statistics", "required": false, "type": { "kind": "instance_of", "type": { "name": "DfsStatisticsProfile", "namespace": "_global.search._types" } } }, { "name": "knn", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "DfsKnnProfile", "namespace": "_global.search._types" } } } } ], "specLocation": "_global/search/_types/profile.ts#L154-L157" }, { "kind": "interface", "name": { "name": "DfsStatisticsBreakdown", "namespace": "_global.search._types" }, "properties": [ { "name": "collection_statistics", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "collection_statistics_count", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "create_weight", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "create_weight_count", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "rewrite", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "rewrite_count", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "term_statistics", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "term_statistics_count", "required": true, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } } ], "specLocation": "_global/search/_types/profile.ts#L170-L179" }, { "kind": "interface", "name": { "name": "DfsStatisticsProfile", "namespace": "_global.search._types" }, "properties": [ { "name": "type", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "description", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "time", "required": false, "type": { "kind": "instance_of", "type": { "name": "Duration", "namespace": "_types" } } }, { "name": "time_in_nanos", "required": true, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "UnitNanos", "namespace": "_types" } } ], "type": { "name": "DurationValue", "namespace": "_types" } } }, { "name": "breakdown", "required": true, "type": { "kind": "instance_of", "type": { "name": "DfsStatisticsBreakdown", "namespace": "_global.search._types" } } }, { "name": "debug", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } }, { "name": "children", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "DfsStatisticsProfile", "namespace": "_global.search._types" } } } } ], "specLocation": "_global/search/_types/profile.ts#L159-L167" }, { "kind": "interface", "name": { "name": "DirectGenerator", "namespace": "_global.search._types" }, "properties": [ { "description": "The field to fetch the candidate suggestions from.\nNeeds to be set globally or per suggestion.", "name": "field", "required": true, "type": { "kind": "instance_of", "type": { "name": "Field", "namespace": "_types" } } }, { "description": "The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.\nCan only be `1` or `2`.", "name": "max_edits", "required": false, "serverDefault": 2, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.\nCan improve accuracy at the cost of performance.", "name": "max_inspections", "required": false, "serverDefault": 5, "type": { "kind": "instance_of", "type": { "name": "float", "namespace": "_types" } } }, { "description": "The maximum threshold in number of documents in which a suggest text token can exist in order to be included.\nThis can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked.\nCan be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.\nIf a value higher than 1 is specified, then fractional can not be specified.", "name": "max_term_freq", "required": false, "serverDefault": 0.01, "type": { "kind": "instance_of", "type": { "name": "float", "namespace": "_types" } } }, { "description": "The minimal threshold in number of documents a suggestion should appear in.\nThis can improve quality by only suggesting high frequency terms.\nCan be specified as an absolute number or as a relative percentage of number of documents.\nIf a value higher than 1 is specified, the number cannot be fractional.", "name": "min_doc_freq", "required": false, "serverDefault": 0, "type": { "kind": "instance_of", "type": { "name": "float", "namespace": "_types" } } }, { "description": "The minimum length a suggest text term must have in order to be included.", "name": "min_word_length", "required": false, "serverDefault": 4, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer.", "name": "post_filter", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "A filter (analyzer) that is applied to each of the tokens passed to this candidate generator.\nThis filter is applied to the original token before candidates are generated.", "name": "pre_filter", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "The number of minimal prefix characters that must match in order be a candidate suggestions.\nIncreasing this number improves spellcheck performance.", "name": "prefix_length", "required": false, "serverDefault": 1, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "The maximum corrections to be returned per suggest text token.", "name": "size", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "Controls what suggestions are included on the suggestions generated on each shard.", "name": "suggest_mode", "required": false, "serverDefault": "missing", "type": { "kind": "instance_of", "type": { "name": "SuggestMode", "namespace": "_types" } } } ], "specLocation": "_global/search/_types/suggester.ts#L268-L331" }, { "kind": "interface", "name": { "name": "FetchProfile", "namespace": "_global.search._types" }, "properties": [ { "name": "type", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "description", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "time_in_nanos", "required": true, "type": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "UnitNanos", "namespace": "_types" } } ], "type": { "name": "DurationValue", "namespace": "_types" } } }, { "name": "breakdown", "required": true, "type": { "kind": "instance_of", "type": { "name": "FetchProfileBreakdown", "namespace": "_global.search._types" } } }, { "name": "debug", "required": false, "type": { "kind": "instance_of", "type": { "name": "FetchProfileDebug", "namespace": "_global.search._types" } } }, { "name": "children", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "FetchProfile", "namespace": "_global.search._types" } } } } ], "specLocation": "_global/search/_types/profile.ts#L230-L237" }, { "kind": "interface", "name": { "name": "FetchProfileBreakdown", "namespace": "_global.search._types" }, "properties": [ { "name": "load_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "load_source_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "load_stored_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "load_stored_fields_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "next_reader", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "next_reader_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "process_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "process", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/search/_types/profile.ts#L239-L248" }, { "kind": "interface", "name": { "name": "FetchProfileDebug", "namespace": "_global.search._types" }, "properties": [ { "name": "stored_fields", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "name": "fast_path", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } } ], "specLocation": "_global/search/_types/profile.ts#L250-L253" }, { "kind": "interface", "extDocId": "collapse-search-results", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/collapse-search-results.html", "name": { "name": "FieldCollapse", "namespace": "_global.search._types" }, "properties": [ { "description": "The field to collapse the result set on", "name": "field", "required": true, "type": { "kind": "instance_of", "type": { "name": "Field", "namespace": "_types" } } }, { "description": "The number of inner hits and their sort order", "name": "inner_hits", "required": false, "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "InnerHits", "namespace": "_global.search._types" } }, { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "InnerHits", "namespace": "_global.search._types" } } } ] } }, { "description": "The number of concurrent requests allowed to retrieve the inner_hits per group", "name": "max_concurrent_group_searches", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "collapse", "required": false, "type": { "kind": "instance_of", "type": { "name": "FieldCollapse", "namespace": "_global.search._types" } } } ], "specLocation": "_global/search/_types/FieldCollapse.ts#L24-L41" }, { "kind": "interface", "name": { "name": "FieldSuggester", "namespace": "_global.search._types" }, "properties": [ { "description": "Provides auto-complete/search-as-you-type functionality.", "name": "completion", "required": false, "type": { "kind": "instance_of", "type": { "name": "CompletionSuggester", "namespace": "_global.search._types" } } }, { "description": "Provides access to word alternatives on a per token basis within a certain string distance.", "name": "phrase", "required": false, "type": { "kind": "instance_of", "type": { "name": "PhraseSuggester", "namespace": "_global.search._types" } } }, { "description": "Suggests terms based on edit distance.", "name": "term", "required": false, "type": { "kind": "instance_of", "type": { "name": "TermSuggester", "namespace": "_global.search._types" } } }, { "containerProperty": true, "description": "Prefix used to search for suggestions.", "name": "prefix", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "containerProperty": true, "description": "A prefix expressed as a regular expression.", "name": "regex", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "containerProperty": true, "description": "The text to use as input for the suggester.\nNeeds to be set globally or per suggestion.", "name": "text", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } ], "specLocation": "_global/search/_types/suggester.ts#L109-L142", "variants": { "kind": "container", "nonExhaustive": true } }, { "kind": "interface", "inherits": { "type": { "name": "HighlightBase", "namespace": "_global.search._types" } }, "name": { "name": "Highlight", "namespace": "_global.search._types" }, "properties": [ { "name": "encoder", "required": false, "type": { "kind": "instance_of", "type": { "name": "HighlighterEncoder", "namespace": "_global.search._types" } } }, { "name": "fields", "required": true, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "Field", "namespace": "_types" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "HighlightField", "namespace": "_global.search._types" } } } } ], "specLocation": "_global/search/_types/highlighting.ts#L152-L155" }, { "kind": "interface", "name": { "name": "HighlightBase", "namespace": "_global.search._types" }, "properties": [ { "name": "type", "required": false, "type": { "kind": "instance_of", "type": { "name": "HighlighterType", "namespace": "_global.search._types" } } }, { "description": "A string that contains each boundary character.", "name": "boundary_chars", "required": false, "serverDefault": ".,!? \\t\\n", "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "description": "How far to scan for boundary characters.", "name": "boundary_max_scan", "required": false, "serverDefault": 20, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "Specifies how to break the highlighted fragments: chars, sentence, or word.\nOnly valid for the unified and fvh highlighters.\nDefaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter.", "name": "boundary_scanner", "required": false, "type": { "kind": "instance_of", "type": { "name": "BoundaryScanner", "namespace": "_global.search._types" } } }, { "description": "Controls which locale is used to search for sentence and word boundaries.\nThis parameter takes a form of a language tag, for example: `\"en-US\"`, `\"fr-FR\"`, `\"ja-JP\"`.", "name": "boundary_scanner_locale", "required": false, "serverDefault": "Locale.ROOT", "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "deprecation": { "description": "", "version": "8.8.0" }, "name": "force_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Specifies how text should be broken up in highlight snippets: `simple` or `span`.\nOnly valid for the `plain` highlighter.", "name": "fragmenter", "required": false, "serverDefault": "span", "type": { "kind": "instance_of", "type": { "name": "HighlighterFragmenter", "namespace": "_global.search._types" } } }, { "description": "The size of the highlighted fragment in characters.", "name": "fragment_size", "required": false, "serverDefault": 100, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "highlight_filter", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Highlight matches for a query other than the search query.\nThis is especially useful if you use a rescore query because those are not taken into account by highlighting by default.", "name": "highlight_query", "required": false, "type": { "kind": "instance_of", "type": { "name": "QueryContainer", "namespace": "_types.query_dsl" } } }, { "name": "max_fragment_length", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "If set to a non-negative value, highlighting stops at this defined maximum limit.\nThe rest of the text is not processed, thus not highlighted and no error is returned\nThe `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting.", "name": "max_analyzed_offset", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.", "name": "no_match_size", "required": false, "serverDefault": 0, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "The maximum number of fragments to return.\nIf the number of fragments is set to `0`, no fragments are returned.\nInstead, the entire field contents are highlighted and returned.\nThis can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.\nIf `number_of_fragments` is `0`, `fragment_size` is ignored.", "name": "number_of_fragments", "required": false, "serverDefault": 5, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "options", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } }, { "description": "Sorts highlighted fragments by score when set to `score`.\nBy default, fragments will be output in the order they appear in the field (order: `none`).\nSetting this option to `score` will output the most relevant fragments first.\nEach highlighter applies its own logic to compute relevancy scores.", "name": "order", "required": false, "serverDefault": "none", "type": { "kind": "instance_of", "type": { "name": "HighlighterOrder", "namespace": "_global.search._types" } } }, { "description": "Controls the number of matching phrases in a document that are considered.\nPrevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.\nWhen using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.\nOnly supported by the `fvh` highlighter.", "name": "phrase_limit", "required": false, "serverDefault": 256, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "description": "Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `` and `` tags.", "name": "post_tags", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "description": "Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `` and `` tags.", "name": "pre_tags", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "description": "By default, only fields that contains a query match are highlighted.\nSet to `false` to highlight all fields.", "name": "require_field_match", "required": false, "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } }, { "description": "Set to `styled` to use the built-in tag schema.", "name": "tags_schema", "required": false, "type": { "kind": "instance_of", "type": { "name": "HighlighterTagsSchema", "namespace": "_global.search._types" } } } ], "specLocation": "_global/search/_types/highlighting.ts#L47-L150" }, { "kind": "interface", "inherits": { "type": { "name": "HighlightBase", "namespace": "_global.search._types" } }, "name": { "name": "HighlightField", "namespace": "_global.search._types" }, "properties": [ { "name": "fragment_offset", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "matched_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "Fields", "namespace": "_types" } } } ], "specLocation": "_global/search/_types/highlighting.ts#L192-L195" }, { "kind": "enum", "members": [ { "name": "default" }, { "name": "html" } ], "name": { "name": "HighlighterEncoder", "namespace": "_global.search._types" }, "specLocation": "_global/search/_types/highlighting.ts#L157-L160" }, { "kind": "enum", "members": [ { "name": "simple" }, { "name": "span" } ], "name": { "name": "HighlighterFragmenter", "namespace": "_global.search._types" }, "specLocation": "_global/search/_types/highlighting.ts#L162-L165" }, { "kind": "enum", "members": [ { "name": "score" } ], "name": { "name": "HighlighterOrder", "namespace": "_global.search._types" }, "specLocation": "_global/search/_types/highlighting.ts#L167-L169" }, { "kind": "enum", "members": [ { "name": "styled" } ], "name": { "name": "HighlighterTagsSchema", "namespace": "_global.search._types" }, "specLocation": "_global/search/_types/highlighting.ts#L171-L173" }, { "kind": "enum", "isOpen": true, "members": [ { "description": "The `plain` highlighter uses the standard Lucene highlighter", "name": "plain" }, { "codegenName": "fast_vector", "description": "The fvh highlighter uses the Lucene Fast Vector highlighter.", "name": "fvh" }, { "description": "The unified highlighter uses the Lucene Unified Highlighter.", "name": "unified" } ], "name": { "name": "HighlighterType", "namespace": "_global.search._types" }, "specLocation": "_global/search/_types/highlighting.ts#L175-L190" }, { "kind": "interface", "generics": [ { "name": "TDocument", "namespace": "_global.search._types.Hit" } ], "name": { "name": "Hit", "namespace": "_global.search._types" }, "properties": [ { "name": "_index", "required": true, "type": { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } } }, { "esQuirk": "'_id' is not available when using 'stored_fields: _none_'\non a search request. Otherwise the field is always present on hits.", "name": "_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "Id", "namespace": "_types" } } }, { "name": "_score", "required": false, "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } }, { "kind": "instance_of", "type": { "name": "null", "namespace": "_builtins" } } ] } }, { "name": "_explanation", "required": false, "type": { "kind": "instance_of", "type": { "name": "Explanation", "namespace": "_global.explain" } } }, { "name": "fields", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "user_defined_value" } } }, { "name": "highlight", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } } }, { "name": "inner_hits", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "InnerHitsResult", "namespace": "_global.search._types" } } } }, { "name": "matched_queries", "required": false, "type": { "kind": "union_of", "items": [ { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } } } ] } }, { "name": "_nested", "required": false, "type": { "kind": "instance_of", "type": { "name": "NestedIdentity", "namespace": "_global.search._types" } } }, { "name": "_ignored", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } } }, { "name": "ignored_field_values", "required": false, "type": { "kind": "dictionary_of", "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } }, "singleKey": false, "value": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "FieldValue", "namespace": "_types" } } } } }, { "name": "_shard", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "_node", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "_routing", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } }, { "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.search._types.Hit" } } }, { "name": "_rank", "required": false, "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } } }, { "name": "_seq_no", "required": false, "type": { "kind": "instance_of", "type": { "name": "SequenceNumber", "namespace": "_types" } } }, { "name": "_primary_term", "required": false, "type": { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } }, { "name": "_version", "required": false, "type": { "kind": "instance_of", "type": { "name": "VersionNumber", "namespace": "_types" } } }, { "name": "sort", "required": false, "type": { "kind": "instance_of", "type": { "name": "SortResults", "namespace": "_types" } } } ], "specLocation": "_global/search/_types/hits.ts#L41-L66" }, { "kind": "interface", "generics": [ { "name": "T", "namespace": "_global.search._types.HitsMetadata" } ], "name": { "name": "HitsMetadata", "namespace": "_global.search._types" }, "properties": [ { "description": "Total hit count information, present only if `track_total_hits` wasn't `false` in the search request.", "name": "total", "required": false, "type": { "kind": "union_of", "items": [ { "kind": "instance_of", "type": { "name": "TotalHits", "namespace": "_global.search._types" } }, { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } } ] } }, { "name": "hits", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "generics": [ { "kind": "instance_of", "type": { "name": "T", "namespace": "_global.search._types.HitsMetadata" } } ], "type": { "name": "Hit", "namespace": "_global.search._types" } } } },