elasticsearch-request-response-specification — quality + safety report

---
name: elasticsearch-request-response-specification
description: "Elasticsearch Request & Response Specification API skill. Use when working with Elasticsearch Request & Response Specification for _async_search, {index}, _bulk. Covers 823 endpoints."
version: 1.0.0
generator: lapsh
---

# Elasticsearch Request & Response Specification

## Auth
ApiKey ids in path

## Base URL
Not specified.

## Setup
1. Set your API key in the appropriate header
2. GET /_cat/aliases -- verify access
3. POST /_async_search -- create first _async_search

## Endpoints

823 endpoints across 79 groups. See references/api-spec.lap for full details.

### _async_search
| Method | Path | Description |
|--------|------|-------------|
| GET | /_async_search/{id} | Get async search results |
| DELETE | /_async_search/{id} | Delete an async search |
| GET | /_async_search/status/{id} | Get the async search status |
| POST | /_async_search | Run an async search |

### {index}
| Method | Path | Description |
|--------|------|-------------|
| POST | /{index}/_async_search | Run an async search |
| PUT | /{index}/_bulk | Bulk index or delete documents |
| POST | /{index}/_bulk | Bulk index or delete documents |
| PUT | /{index}/_ccr/follow | Create a follower |
| GET | /{index}/_ccr/info | Get follower information |
| GET | /{index}/_ccr/stats | Get follower stats |
| POST | /{index}/_ccr/forget_follower | Forget a follower |
| POST | /{index}/_ccr/pause_follow | Pause a follower |
| POST | /{index}/_ccr/resume_follow | Resume a follower |
| POST | /{index}/_ccr/unfollow | Unfollow an index |
| GET | /{index}/_count | Count search results |
| POST | /{index}/_count | Count search results |
| PUT | /{index}/_create/{id} | Create a new document in the index |
| POST | /{index}/_create/{id} | Create a new document in the index |
| GET | /{index}/_doc/{id} | Get a document by its ID |
| PUT | /{index}/_doc/{id} | Create or update a document in an index |
| POST | /{index}/_doc/{id} | Create or update a document in an index |
| DELETE | /{index}/_doc/{id} | Delete a document |
| HEAD | /{index}/_doc/{id} | Check a document |
| POST | /{index}/_delete_by_query | Delete documents |
| GET | /{index}/_eql/search | Get EQL search results |
| POST | /{index}/_eql/search | Get EQL search results |
| GET | /{index}/_source/{id} | Get a document's source |
| HEAD | /{index}/_source/{id} | Check for a document source |
| GET | /{index}/_explain/{id} | Explain a document match result |
| POST | /{index}/_explain/{id} | Explain a document match result |
| GET | /{index}/_field_caps | Get the field capabilities |
| POST | /{index}/_field_caps | Get the field capabilities |
| GET | /{index}/_fleet/global_checkpoints | Get global checkpoints |
| GET | /{index}/_fleet/_fleet_msearch | Run multiple Fleet searches |
| POST | /{index}/_fleet/_fleet_msearch | Run multiple Fleet searches |
| GET | /{index}/_fleet/_fleet_search | Run a Fleet search |
| POST | /{index}/_fleet/_fleet_search | Run a Fleet search |
| GET | /{index}/_graph/explore | Explore graph analytics |
| POST | /{index}/_graph/explore | Explore graph analytics |
| GET | /{index}/_ilm/explain | Explain the lifecycle state |
| POST | /{index}/_ilm/remove | Remove policies from an index |
| POST | /{index}/_ilm/retry | Retry a policy |
| POST | /{index}/_doc | Create or update a document in an index |
| PUT | /{index}/_block/{block} | Add an index block |
| DELETE | /{index}/_block/{block} | Remove an index block |
| GET | /{index}/_analyze | Get tokens from text analysis |
| POST | /{index}/_analyze | Get tokens from text analysis |
| POST | /{index}/_cache/clear | Clear the cache |
| PUT | /{index}/_clone/{target} | Clone an index |
| POST | /{index}/_clone/{target} | Clone an index |
| POST | /{index}/_close | Close an index |
| GET | /{index} | Get index information |
| PUT | /{index} | Create an index |
| DELETE | /{index} | Delete indices |
| HEAD | /{index} | Check indices |
| GET | /{index}/_alias/{name} | Get aliases |
| PUT | /{index}/_alias/{name} | Create or update an alias |
| POST | /{index}/_alias/{name} | Create or update an alias |
| DELETE | /{index}/_alias/{name} | Delete an alias |
| HEAD | /{index}/_alias/{name} | Check aliases |
| PUT | /{index}/_aliases/{name} | Create or update an alias |
| POST | /{index}/_aliases/{name} | Create or update an alias |
| DELETE | /{index}/_aliases/{name} | Delete an alias |
| POST | /{index}/_disk_usage | Analyze the index disk usage |
| POST | /{index}/_downsample/{target_index} | Downsample an index |
| GET | /{index}/_lifecycle/explain | Get the status for a data stream lifecycle |
| GET | /{index}/_field_usage_stats | Get field usage stats |
| GET | /{index}/_flush | Flush data streams or indices |
| POST | /{index}/_flush | Flush data streams or indices |
| POST | /{index}/_forcemerge | Force a merge |
| GET | /{index}/_alias | Get aliases |
| GET | /{index}/_mapping/field/{fields} | Get mapping definitions |
| GET | /{index}/_mapping | Get mapping definitions |
| PUT | /{index}/_mapping | Update field mappings |
| POST | /{index}/_mapping | Update field mappings |
| GET | /{index}/_settings | Get index settings |
| PUT | /{index}/_settings | Update index settings |
| GET | /{index}/_settings/{name} | Get index settings |
| POST | /{index}/_open | Open a closed index |
| GET | /{index}/_recovery | Get index recovery information |
| GET | /{index}/_refresh | Refresh an index |
| POST | /{index}/_refresh | Refresh an index |
| GET | /{index}/_reload_search_analyzers | Reload search analyzers |
| POST | /{index}/_reload_search_analyzers | Reload search analyzers |
| GET | /{index}/_segments | Get index segments |
| GET | /{index}/_shard_stores | Get index shard stores |
| PUT | /{index}/_shrink/{target} | Shrink an index |
| POST | /{index}/_shrink/{target} | Shrink an index |
| PUT | /{index}/_split/{target} | Split an index |
| POST | /{index}/_split/{target} | Split an index |
| GET | /{index}/_stats | Get index statistics |
| GET | /{index}/_stats/{metric} | Get index statistics |
| GET | /{index}/_validate/query | Validate a query |
| POST | /{index}/_validate/query | Validate a query |
| GET | /{index}/_mget | Get multiple documents |
| POST | /{index}/_mget | Get multiple documents |
| GET | /{index}/_migration/deprecations | Get deprecation information |
| GET | /{index}/_msearch | Run multiple searches |
| POST | /{index}/_msearch | Run multiple searches |
| GET | /{index}/_msearch/template | Run multiple templated searches |
| POST | /{index}/_msearch/template | Run multiple templated searches |
| GET | /{index}/_mtermvectors | Get multiple term vectors |
| POST | /{index}/_mtermvectors | Get multiple term vectors |
| POST | /{index}/_pit | Open a point in time |
| GET | /{index}/_rank_eval | Evaluate ranked search results |
| POST | /{index}/_rank_eval | Evaluate ranked search results |
| GET | /{index}/_rollup/data | Get the rollup index capabilities |
| GET | /{index}/_rollup_search | Search rolled-up data |
| POST | /{index}/_rollup_search | Search rolled-up data |
| GET | /{index}/_search | Run a search |
| POST | /{index}/_search | Run a search |
| GET | /{index}/_mvt/{field}/{zoom}/{x}/{y} | Search a vector tile |
| POST | /{index}/_mvt/{field}/{zoom}/{x}/{y} | Search a vector tile |
| GET | /{index}/_search_shards | Get the search shards |
| POST | /{index}/_search_shards | Get the search shards |
| GET | /{index}/_search/template | Run a search with a search template |
| POST | /{index}/_search/template | Run a search with a search template |
| POST | /{index}/_searchable_snapshots/cache/clear | Clear the cache |
| GET | /{index}/_searchable_snapshots/stats | Get searchable snapshot statistics |
| GET | /{index}/_terms_enum | Get terms in an index |
| POST | /{index}/_terms_enum | Get terms in an index |
| GET | /{index}/_termvectors/{id} | Get term vector information |
| POST | /{index}/_termvectors/{id} | Get term vector information |
| GET | /{index}/_termvectors | Get term vector information |
| POST | /{index}/_termvectors | Get term vector information |
| POST | /{index}/_update/{id} | Update a document |
| POST | /{index}/_update_by_query | Update documents |

### _bulk
| Method | Path | Description |
|--------|------|-------------|
| PUT | /_bulk | Bulk index or delete documents |
| POST | /_bulk | Bulk index or delete documents |

### _cat
| Method | Path | Description |
|--------|------|-------------|
| GET | /_cat/aliases | Get aliases |
| GET | /_cat/aliases/{name} | Get aliases |
| GET | /_cat/allocation | Get shard allocation information |
| GET | /_cat/allocation/{node_id} | Get shard allocation information |
| GET | /_cat/circuit_breaker | Get circuit breakers statistics |
| GET | /_cat/circuit_breaker/{circuit_breaker_patterns} | Get circuit breakers statistics |
| GET | /_cat/component_templates | Get component templates |
| GET | /_cat/component_templates/{name} | Get component templates |
| GET | /_cat/count | Get a document count |
| POST | /_cat/count | Get a document count |
| GET | /_cat/count/{index} | Get a document count |
| POST | /_cat/count/{index} | Get a document count |
| GET | /_cat/fielddata | Get field data cache information |
| GET | /_cat/fielddata/{fields} | Get field data cache information |
| GET | /_cat/health | Get the cluster health status |
| GET | /_cat | Get CAT help |
| GET | /_cat/indices | Get index information |
| GET | /_cat/indices/{index} | Get index information |
| GET | /_cat/master | Get master node information |
| GET | /_cat/ml/data_frame/analytics | Get data frame analytics jobs |
| GET | /_cat/ml/data_frame/analytics/{id} | Get data frame analytics jobs |
| GET | /_cat/ml/datafeeds | Get datafeeds |
| GET | /_cat/ml/datafeeds/{datafeed_id} | Get datafeeds |
| GET | /_cat/ml/anomaly_detectors | Get anomaly detection jobs |
| GET | /_cat/ml/anomaly_detectors/{job_id} | Get anomaly detection jobs |
| GET | /_cat/ml/trained_models | Get trained models |
| GET | /_cat/ml/trained_models/{model_id} | Get trained models |
| GET | /_cat/nodeattrs | Get node attribute information |
| GET | /_cat/nodes | Get node information |
| GET | /_cat/pending_tasks | Get pending task information |
| GET | /_cat/plugins | Get plugin information |
| GET | /_cat/recovery | Get shard recovery information |
| GET | /_cat/recovery/{index} | Get shard recovery information |
| GET | /_cat/repositories | Get snapshot repository information |
| GET | /_cat/segments | Get segment information |
| GET | /_cat/segments/{index} | Get segment information |
| GET | /_cat/shards | Get shard information |
| GET | /_cat/shards/{index} | Get shard information |
| GET | /_cat/snapshots | Get snapshot information |
| GET | /_cat/snapshots/{repository} | Get snapshot information |
| GET | /_cat/tasks | Get task information |
| GET | /_cat/templates | Get index template information |
| GET | /_cat/templates/{name} | Get index template information |
| GET | /_cat/thread_pool | Get thread pool statistics |
| GET | /_cat/thread_pool/{thread_pool_patterns} | Get thread pool statistics |
| GET | /_cat/transforms | Get transform information |
| GET | /_cat/transforms/{transform_id} | Get transform information |

### _ccr
| Method | Path | Description |
|--------|------|-------------|
| GET | /_ccr/auto_follow/{name} | Get auto-follow patterns |
| PUT | /_ccr/auto_follow/{name} | Create or update auto-follow patterns |
| DELETE | /_ccr/auto_follow/{name} | Delete auto-follow patterns |
| GET | /_ccr/auto_follow | Get auto-follow patterns |
| POST | /_ccr/auto_follow/{name}/pause | Pause an auto-follow pattern |
| POST | /_ccr/auto_follow/{name}/resume | Resume an auto-follow pattern |
| GET | /_ccr/stats | Get cross-cluster replication stats |

### _search
| Method | Path | Description |
|--------|------|-------------|
| GET | /_search/scroll | Run a scrolling search |
| POST | /_search/scroll | Run a scrolling search |
| DELETE | /_search/scroll | Clear a scrolling search |
| GE

… (truncated)