Open Distro for Elasticsearch

https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference/
Admin
Open Distro for Elasticsearch is an open-source distribution of Elasticsearch that provides advanced...
Tokens:123,084
Snippets:622
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET _cat/plugins

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information about installed plugins across nodes. Supports URL parameters such as format, local, master_timeout, h, help, s, and v.

```http
GET _cat/plugins

```

--------------------------------

### Get Cat API help

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns help for the Cat APIs. Use the help URL parameter to get more information.

```http
GET _cat

```

--------------------------------

### GET _cat/plugins

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information about installed plugins across nodes. This endpoint is useful for verifying plugin installations across the cluster.

```APIDOC
## GET _cat/plugins

### Description
Returns information about installed plugins across nodes.

### Method
GET

### Endpoint
_cat/plugins

### Parameters
#### Query Parameters
- **format** (string) - Optional - A short version of the Accept header, e.g. json, yaml
- **local** (boolean) - Optional - Return local information, do not retrieve the state from master node (default: false)
- **master_timeout** (time) - Optional - Explicit operation timeout for connection to master node
- **h** (list) - Optional - Comma-separated list of column names to display
- **help** (boolean) - Optional - Return help information
- **s** (list) - Optional - Comma-separated list of column names or column aliases to sort by
- **v** (boolean) - Optional - Verbose mode. Display column headers

### Request Example
```
GET _cat/plugins
```

### Response
#### Success Response (200)
Returns information about installed plugins across nodes.

```

--------------------------------

### ingest.simulate

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Allows to simulate a pipeline with example documents.

```APIDOC
## GET _ingest/pipeline/_simulate

### Description
Allows to simulate a pipeline with example documents.

### Method
GET

### Endpoint
_ingest/pipeline/_simulate

### Parameters
#### URL Parameters
- **verbose** (boolean) - Verbose mode. Display data output for each processor in executed pipeline

#### Request Body
The simulate definition (Required)

---

## POST _ingest/pipeline/_simulate

### Description
Allows to simulate a pipeline with example documents.

### Method
POST

### Endpoint
_ingest/pipeline/_simulate

### Parameters
#### URL Parameters
- **verbose** (boolean) - Verbose mode. Display data output for each processor in executed pipeline

#### Request Body
The simulate definition (Required)

---

## GET _ingest/pipeline/{id}/_simulate

### Description
Allows to simulate a pipeline with example documents.

### Method
GET

### Endpoint
_ingest/pipeline/{id}/_simulate

### Parameters
#### URL Parameters
- **verbose** (boolean) - Verbose mode. Display data output for each processor in executed pipeline

#### Request Body
The simulate definition (Required)

---

## POST _ingest/pipeline/{id}/_simulate

### Description
Allows to simulate a pipeline with example documents.

### Method
POST

### Endpoint
_ingest/pipeline/{id}/_simulate

### Parameters
#### URL Parameters
- **verbose** (boolean) - Verbose mode. Display data output for each processor in executed pipeline

#### Request Body
The simulate definition (Required)
```

--------------------------------

### Get all component templates

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns all component templates.

```http
GET _component_template

```

--------------------------------

### GET _snapshot[/{repository}]

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information about a repository.

```APIDOC
## GET _snapshot

### Description
Returns information about a repository.

### Method
GET

### Endpoint
_snapshot

### Parameters
#### Query Parameters
- **master_timeout** (time) - Optional - Explicit operation timeout for connection to master node.
- **local** (boolean) - Optional - Return local information, do not retrieve the state from master node (default: false).
```

```APIDOC
## GET _snapshot/{repository}

### Description
Returns information about a repository.

### Method
GET

### Endpoint
_snapshot/{repository}

### Parameters
#### Path Parameters
- **repository** (string) - Required - The name of the repository.

#### Query Parameters
- **master_timeout** (time) - Optional - Explicit operation timeout for connection to master node.
- **local** (boolean) - Optional - Return local information, do not retrieve the state from master node (default: false).
```

--------------------------------

### Get all index templates

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns all index templates.

```http
GET _template

```

--------------------------------

### Get task information with GET _tasks/{task_id}

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information about a task. The {task_id} path parameter must be replaced with the task ID.

```http
GET _tasks/{task_id}

```

--------------------------------

### Get cluster settings

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns cluster settings.

```http
GET _cluster/settings

```

--------------------------------

### GET _cat

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns help for the Cat APIs.

```APIDOC
## GET _cat

### Description
Returns help for the Cat APIs.

### Method
GET

### Endpoint
_cat

### Parameters
#### Query Parameters
- **help** (boolean) - Optional - Return help information
- **s** (list) - Optional - Comma-separated list of column names or column aliases to sort by
```

--------------------------------

### Get settings for all indices

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns settings for all indices.

```http
GET _settings

```

--------------------------------

### GET _tasks

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns a list of tasks.

```APIDOC
## [GET] _tasks

### Description
Returns a list of tasks.

### Method
GET

### Endpoint
_tasks

### Parameters
#### URL Parameters
- **nodes** (list) - Optional - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you’re connecting to, leave empty to get information from all nodes
- **actions** (list) - Optional - A comma-separated list of actions that should be returned. Leave empty to return all.
- **detailed** (boolean) - Optional - Return detailed task information (default: false)
- **parent_task_id** (string) - Optional - Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
- **wait_for_completion** (boolean) - Optional - Wait for the matching tasks to complete (default: false)
- **group_by** (enum) - Optional - Group tasks by nodes or parent/child relationships
- **timeout** (time) - Optional - Explicit operation timeout

```

--------------------------------

### GET _snapshot/{repository}/{snapshot}

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information about a snapshot.

```APIDOC
## GET _snapshot/{repository}/{snapshot}

### Description
Returns information about a snapshot.

### Method
GET

### Endpoint
_snapshot/{repository}/{snapshot}

### Parameters
#### Path Parameters
- **repository** (string) - Required - The name of the repository.
- **snapshot** (string) - Required - The name of the snapshot.

#### Query Parameters
- **master_timeout** (time) - Optional - Explicit operation timeout for connection to master node.
- **ignore_unavailable** (boolean) - Optional - Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown.
- **verbose** (boolean) - Optional - Whether to show verbose snapshot info or only show the basic info found in the repository index blob.
```

--------------------------------

### Create snapshot repository: PUT/POST _snapshot/{repository}

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Creates a snapshot repository. The request body is required and contains the repository definition. The verify parameter controls whether to verify the repository after creation.

```http
PUT _snapshot/{repository}
POST _snapshot/{repository}

```

--------------------------------

### GET/POST {index}/_explain/{id}

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information about why a document matches or doesn't match a query. Both GET and POST methods are supported. The {index} and {id} placeholders must be replaced with actual values.

```http
GET {index}/_explain/{id}
POST {index}/_explain/{id}

```

--------------------------------

### Get script contexts: GET _script_context

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns all script contexts supported by the cluster.

```http
GET _script_context

```

--------------------------------

### GET _mtermvectors

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns multiple termvectors in one request. Supports GET and POST methods.

```APIDOC
## [GET] _mtermvectors

### Description
Returns multiple termvectors in one request.

### Method
GET

### Endpoint
_mtermvectors

### Parameters
#### URL Parameters
- **ids** (list) - A comma-separated list of documents ids. You must define ids as parameter or set “ids” or “docs” in the request body
- **term_statistics** (boolean) - Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **field_statistics** (boolean) - Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **fields** (list) - A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **offsets** (boolean) - Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **positions** (boolean) - Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **payloads** (boolean) - Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **preference** (string) - Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **routing** (string) - Specific routing value. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **realtime** (boolean) - Specifies if requests are real-time as opposed to near-real-time (default: true).
- **version** (number) - Explicit version number for concurrency control
- **version_type** (enum) - Specific version type

### Request Body
- **ids, documents, parameters or a list of parameters per document** - Optional - Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.

```

--------------------------------

### Explain shard allocation with GET/POST _cluster/allocation/explain

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Provides explanations for shard allocations in the cluster. Both GET and POST methods are supported. The request body can specify the index, shard, and primary flag; an empty body explains the first unassigned shard.

```http
GET _cluster/allocation/explain
POST _cluster/allocation/explain

```

--------------------------------

### GET/POST {index}/{type}/{id}/_explain

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information about why a document matches or doesn't match a query, with a type parameter. Both GET and POST methods are supported. The {index}, {type}, and {id} placeholders must be replaced with actual values.

```http
GET {index}/{type}/{id}/_explain
POST {index}/{type}/{id}/_explain

```

--------------------------------

### Get script languages: GET _script_language

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns available script types, languages, and contexts.

```http
GET _script_language

```

--------------------------------

### Verify repository with POST _snapshot/{repository}/_verify

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Verifies a repository. The {repository} path parameter must be replaced with the repository name.

```http
POST _snapshot/{repository}/_verify

```

--------------------------------

### Get remote cluster info with GET _remote/info

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information about configured remote clusters.

```http
GET _remote/info

```

--------------------------------

### Create snapshot: PUT/POST _snapshot/{repository}/{snapshot}

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Creates a snapshot in a repository. The request body is optional and contains the snapshot definition. The wait_for_completion parameter controls whether the request waits for completion before returning.

```http
PUT _snapshot/{repository}/{snapshot}
POST _snapshot/{repository}/{snapshot}

```

--------------------------------

### GET _msearch/template

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Executes several search template operations in one request. Supports GET and POST methods.

```APIDOC
## [GET] _msearch/template

### Description
Allows to execute several search template operations in one request.

### Method
GET

### Endpoint
_msearch/template

### Parameters
#### URL Parameters
- **search_type** (enum) - Search operation type
- **typed_keys** (boolean) - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
- **max_concurrent_searches** (number) - Controls the maximum number of concurrent searches the multi search api will execute
- **rest_total_hits_as_int** (boolean) - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
- **ccs_minimize_roundtrips** (boolean) - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution

### Request Body
- **request definitions** (metadata-search request definition pairs) - Required - The request definitions (metadata-search request definition pairs), separated by newlines

```

--------------------------------

### Get script: GET _scripts/{id}

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Retrieves a stored script by its ID. The {id} path parameter is required.

```http
GET _scripts/{id}

```

--------------------------------

### GET _cluster/health

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns basic information about the health of the cluster. Optionally, specify an index to get health for that index only.

```APIDOC
## [GET] _cluster/health

### Description
Returns basic information about the health of the cluster.

### Method
GET

### Endpoint
_cluster/health

### Parameters
#### Path Parameters
- **index** (string) - Optional - The index name to get health for.

#### Query Parameters
- **expand_wildcards** (enum) - Optional - Whether to expand wildcard expression to concrete indices that are open, closed or both.
- **level** (enum) - Optional - Specify the level of detail for returned information.
- **local** (boolean) - Optional - Return local information, do not retrieve the state from master node (default: false).
- **master_timeout** (time) - Optional - Explicit operation timeout for connection to master node.
- **timeout** (time) - Optional - Explicit operation timeout.
- **wait_for_active_shards** (string) - Optional - Wait until the specified number of shards is active.
- **wait_for_nodes** (string) - Optional - Wait until the specified number of nodes is available.
- **wait_for_events** (enum) - Optional - Wait until all currently queued events with the given priority are processed.
- **wait_for_no_relocating_shards** (boolean) - Optional - Whether to wait until there are no relocating shards in the cluster.
- **wait_for_no_initializing_shards** (boolean) - Optional - Whether to wait until there are no initializing shards in the cluster.
- **wait_for_status** (enum) - Optional - Wait until cluster is in a specific state.

### Request Example
```
GET _cluster/health
```

### Response
#### Success Response (200)
Returns cluster health information.

#### Response Example
```
{
  "cluster_name": "elasticsearch",
  "status": "green",
  "timed_out": false,
  "number_of_nodes": 1,
  "number_of_data_nodes": 1,
  "active_primary_shards": 0,
  "active_shards": 0,
  "relocating_shards": 0,
  "initializing_shards": 0,
  "unassigned_shards": 0
}
```

```

--------------------------------

### GET {index}/_termvectors

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information and statistics about terms in the fields of a particular document. Supports both GET and POST methods.

```APIDOC
## [GET] {index}/_termvectors

### Description
Returns information and statistics about terms in the fields of a particular document.

### Method
GET

### Endpoint
{index}/_termvectors

### Parameters
#### URL Parameters
- **term_statistics** (boolean) - Optional - Specifies if total term frequency and document frequency should be returned.
- **field_statistics** (boolean) - Optional - Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
- **fields** (list) - Optional - A comma-separated list of fields to return.
- **offsets** (boolean) - Optional - Specifies if term offsets should be returned.
- **positions** (boolean) - Optional - Specifies if term positions should be returned.
- **payloads** (boolean) - Optional - Specifies if term payloads should be returned.
- **preference** (string) - Optional - Specify the node or shard the operation should be performed on (default: random).
- **routing** (string) - Optional - Specific routing value.
- **realtime** (boolean) - Optional - Specifies if request is real-time as opposed to near-real-time (default: true).
- **version** (number) - Optional - Explicit version number for concurrency control.
- **version_type** (enum) - Optional - Specific version type.

### Request Body
Optional. Define parameters and/or supply a document to get termvectors for. See documentation.

### Response
Returns information and statistics about terms in the fields of a particular document.
```

--------------------------------

### POST {index}/_open

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Opens an index. Supports URL parameters such as timeout, master_timeout, ignore_unavailable, allow_no_indices, expand_wildcards, and wait_for_active_shards.

```http
POST {index}/_open

```

--------------------------------

### GET {index}/_mtermvectors

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns multiple termvectors in one request for a specific index. Supports GET and POST methods.

```APIDOC
## [GET] {index}/_mtermvectors

### Description
Returns multiple termvectors in one request for a specific index.

### Method
GET

### Endpoint
{index}/_mtermvectors

### Parameters
#### Path Parameters
- **index** (string) - Required - The index name.

#### URL Parameters
- **ids** (list) - A comma-separated list of documents ids. You must define ids as parameter or set “ids” or “docs” in the request body
- **term_statistics** (boolean) - Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **field_statistics** (boolean) - Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **fields** (list) - A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **offsets** (boolean) - Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **positions** (boolean) - Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **payloads** (boolean) - Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **preference** (string) - Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **routing** (string) - Specific routing value. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **realtime** (boolean) - Specifies if requests are real-time as opposed to near-real-time (default: true).
- **version** (number) - Explicit version number for concurrency control
- **version_type** (enum) - Specific version type

### Request Body
- **ids, documents, parameters or a list of parameters per document** - Optional - Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.

```

--------------------------------

### POST {index}/{type}/{id}/_explain

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information about why a specific matches (or doesn’t match) a query.

```APIDOC
## POST {index}/{type}/{id}/_explain

### Description
Returns information about why a specific matches (or doesn’t match) a query.

### Method
POST

### Endpoint
{index}/{type}/{id}/_explain

### Parameters
#### URL Parameters
- **analyze_wildcard** (boolean) - Optional - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
- **analyzer** (string) - Optional - The analyzer for the query string query
- **default_operator** (enum) - Optional - The default operator for query string query (AND or OR)
- **df** (string) - Optional - The default field for query string query (default: _all)
- **stored_fields** (list) - Optional - A comma-separated list of stored fields to return in the response
- **lenient** (boolean) - Optional - Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
- **preference** (string) - Optional - Specify the node or shard the operation should be performed on (default: random)
- **q** (string) - Optional - Query in the Lucene query string syntax
- **routing** (string) - Optional - Specific routing value
- **_source** (list) - Optional - True or false to return the _source field or not, or a list of fields to return
- **_source_excludes** (list) - Optional - A list of fields to exclude from the returned _source field
- **_source_includes** (list) - Optional - A list of fields to extract and return from the _source field

#### Request Body
The query definition using the Query DSL

```

--------------------------------

### List snapshots with _cat/snapshots

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns all snapshots in a specific repository. The first form lists all snapshots in all repositories; the second form limits results to the named repository.

```http
GET _cat/snapshots

```

```http
GET _cat/snapshots/{repository}

```

--------------------------------

### GET {index}/{type}/_termvectors

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information and statistics about terms in the fields of a particular document. Supports both GET and POST methods.

```APIDOC
## [GET] {index}/{type}/_termvectors

### Description
Returns information and statistics about terms in the fields of a particular document.

### Method
GET

### Endpoint
{index}/{type}/_termvectors

### Parameters
#### URL Parameters
- **term_statistics** (boolean) - Optional - Specifies if total term frequency and document frequency should be returned.
- **field_statistics** (boolean) - Optional - Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
- **fields** (list) - Optional - A comma-separated list of fields to return.
- **offsets** (boolean) - Optional - Specifies if term offsets should be returned.
- **positions** (boolean) - Optional - Specifies if term positions should be returned.
- **payloads** (boolean) - Optional - Specifies if term payloads should be returned.
- **preference** (string) - Optional - Specify the node or shard the operation should be performed on (default: random).
- **routing** (string) - Optional - Specific routing value.
- **realtime** (boolean) - Optional - Specifies if request is real-time as opposed to near-real-time (default: true).
- **version** (number) - Optional - Explicit version number for concurrency control.
- **version_type** (enum) - Optional - Specific version type.

### Request Body
Optional. Define parameters and/or supply a document to get termvectors for. See documentation.

### Response
Returns information and statistics about terms in the fields of a particular document.
```

--------------------------------

### GET {index}/_termvectors/{id}

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information and statistics about terms in the fields of a particular document. Supports both GET and POST methods.

```APIDOC
## [GET] {index}/_termvectors/{id}

### Description
Returns information and statistics about terms in the fields of a particular document.

### Method
GET

### Endpoint
{index}/_termvectors/{id}

### Parameters
#### URL Parameters
- **term_statistics** (boolean) - Optional - Specifies if total term frequency and document frequency should be returned.
- **field_statistics** (boolean) - Optional - Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
- **fields** (list) - Optional - A comma-separated list of fields to return.
- **offsets** (boolean) - Optional - Specifies if term offsets should be returned.
- **positions** (boolean) - Optional - Specifies if term positions should be returned.
- **payloads** (boolean) - Optional - Specifies if term payloads should be returned.
- **preference** (string) - Optional - Specify the node or shard the operation should be performed on (default: random).
- **routing** (string) - Optional - Specific routing value.
- **realtime** (boolean) - Optional - Specifies if request is real-time as opposed to near-real-time (default: true).
- **version** (number) - Optional - Explicit version number for concurrency control.
- **version_type** (enum) - Optional - Specific version type.

### Request Body
Optional. Define parameters and/or supply a document to get termvectors for. See documentation.

### Response
Returns information and statistics about terms in the fields of a particular document.
```

--------------------------------

### POST {index}/_explain/{id}

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information about why a specific matches (or doesn’t match) a query.

```APIDOC
## POST {index}/_explain/{id}

### Description
Returns information about why a specific matches (or doesn’t match) a query.

### Method
POST

### Endpoint
{index}/_explain/{id}

### Parameters
#### URL Parameters
- **analyze_wildcard** (boolean) - Optional - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
- **analyzer** (string) - Optional - The analyzer for the query string query
- **default_operator** (enum) - Optional - The default operator for query string query (AND or OR)
- **df** (string) - Optional - The default field for query string query (default: _all)
- **stored_fields** (list) - Optional - A comma-separated list of stored fields to return in the response
- **lenient** (boolean) - Optional - Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
- **preference** (string) - Optional - Specify the node or shard the operation should be performed on (default: random)
- **q** (string) - Optional - Query in the Lucene query string syntax
- **routing** (string) - Optional - Specific routing value
- **_source** (list) - Optional - True or false to return the _source field or not, or a list of fields to return
- **_source_excludes** (list) - Optional - A list of fields to exclude from the returned _source field
- **_source_includes** (list) - Optional - A list of fields to extract and return from the _source field

#### Request Body
The query definition using the Query DSL

```

--------------------------------

### PUT/POST _snapshot/{repository}

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Creates a repository. Supports both PUT and POST methods.

```APIDOC
## [PUT] _snapshot/{repository}

### Description
Creates a repository.

### Method
PUT

### Endpoint
_snapshot/{repository}

### Parameters
#### Path Parameters
- **repository** (string) - Required - The name of the repository

#### Query Parameters
- **master_timeout** (time) - Optional - Explicit operation timeout for connection to master node
- **timeout** (time) - Optional - Explicit operation timeout
- **verify** (boolean) - Optional - Whether to verify the repository after creation

#### Request Body
- **repository definition** (object) - Required - The repository definition

```

```APIDOC
## [POST] _snapshot/{repository}

### Description
Creates a repository.

### Method
POST

### Endpoint
_snapshot/{repository}

### Parameters
#### Path Parameters
- **repository** (string) - Required - The name of the repository

#### Query Parameters
- **master_timeout** (time) - Optional - Explicit operation timeout for connection to master node
- **timeout** (time) - Optional - Explicit operation timeout
- **verify** (boolean) - Optional - Whether to verify the repository after creation

#### Request Body
- **repository definition** (object) - Required - The repository definition

```

--------------------------------

### GET {index}/{type}/{id}/_termvectors

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information and statistics about terms in the fields of a particular document. Supports both GET and POST methods.

```APIDOC
## [GET] {index}/{type}/{id}/_termvectors

### Description
Returns information and statistics about terms in the fields of a particular document.

### Method
GET

### Endpoint
{index}/{type}/{id}/_termvectors

### Parameters
#### URL Parameters
- **term_statistics** (boolean) - Optional - Specifies if total term frequency and document frequency should be returned.
- **field_statistics** (boolean) - Optional - Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
- **fields** (list) - Optional - A comma-separated list of fields to return.
- **offsets** (boolean) - Optional - Specifies if term offsets should be returned.
- **positions** (boolean) - Optional - Specifies if term positions should be returned.
- **payloads** (boolean) - Optional - Specifies if term payloads should be returned.
- **preference** (string) - Optional - Specify the node or shard the operation should be performed on (default: random).
- **routing** (string) - Optional - Specific routing value.
- **realtime** (boolean) - Optional - Specifies if request is real-time as opposed to near-real-time (default: true).
- **version** (number) - Optional - Explicit version number for concurrency control.
- **version_type** (enum) - Optional - Specific version type.

### Request Body
Optional. Define parameters and/or supply a document to get termvectors for. See documentation.

### Response
Returns information and statistics about terms in the fields of a particular document.
```

--------------------------------

### Create an index with PUT

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Creates an index with optional settings and mappings in the HTTP request body. URL parameters include include_type_name, wait_for_active_shards, timeout, and master_timeout.

```http
PUT {index}

```

--------------------------------

### Search Shards API: All Indices

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Use these requests to get shard information for a search across all indices. The GET and POST methods are equivalent.

```http
GET _search_shards
POST _search_shards

```

--------------------------------

### GET {index}/{type}/_mtermvectors

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns multiple termvectors in one request for a specific index and type. Supports GET and POST methods.

```APIDOC
## [GET] {index}/{type}/_mtermvectors

### Description
Returns multiple termvectors in one request for a specific index and type.

### Method
GET

### Endpoint
{index}/{type}/_mtermvectors

### Parameters
#### Path Parameters
- **index** (string) - Required - The index name.
- **type** (string) - Required - The document type.

#### URL Parameters
- **ids** (list) - A comma-separated list of documents ids. You must define ids as parameter or set “ids” or “docs” in the request body
- **term_statistics** (boolean) - Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **field_statistics** (boolean) - Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **fields** (list) - A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **offsets** (boolean) - Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **positions** (boolean) - Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **payloads** (boolean) - Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **preference** (string) - Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **routing** (string) - Specific routing value. Applies to all returned documents unless otherwise specified in body “params” or “docs”.
- **realtime** (boolean) - Specifies if requests are real-time as opposed to near-real-time (default: true).
- **version** (number) - Explicit version number for concurrency control
- **version_type** (enum) - Specific version type

### Request Body
- **ids, documents, parameters or a list of parameters per document** - Optional - Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.

```

--------------------------------

### GET {index}/_msearch/template

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Executes several search template operations in one request for a specific index. Supports GET and POST methods.

```APIDOC
## [GET] {index}/_msearch/template

### Description
Allows to execute several search template operations in one request for a specific index.

### Method
GET

### Endpoint
{index}/_msearch/template

### Parameters
#### Path Parameters
- **index** (string) - Required - The index name.

#### URL Parameters
- **search_type** (enum) - Search operation type
- **typed_keys** (boolean) - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
- **max_concurrent_searches** (number) - Controls the maximum number of concurrent searches the multi search api will execute
- **rest_total_hits_as_int** (boolean) - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
- **ccs_minimize_roundtrips** (boolean) - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution

### Request Body
- **request definitions** (metadata-search request definition pairs) - Required - The request definitions (metadata-search request definition pairs), separated by newlines

```

--------------------------------

### Simulate index template matching with POST _index_template/_simulate_index/{name}

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Simulates matching the given index name against the index templates in the system. The optional request body can include a new index template definition to be included in the simulation as if it already exists.

```http
POST _index_template/_simulate_index/{name}

```

--------------------------------

### Get cat templates

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information about existing templates. The first request lists all templates; the second retrieves a specific template by name.

```http
GET _cat/templates

```

```http
GET _cat/templates/{name}

```

--------------------------------

### GET _cat/shards and GET _cat/shards/{index}

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Provides a detailed view of shard allocation on nodes. The second form targets a specific index.

```http
GET _cat/shards

```

```http
GET _cat/shards/{index}

```

--------------------------------

### GET _cat/segments and GET _cat/segments/{index}

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Provides low-level information about the segments in the shards of an index. The second form targets a specific index.

```http
GET _cat/segments

```

```http
GET _cat/segments/{index}

```

--------------------------------

### indices.create

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Creates a new index with optional settings and mappings.

```APIDOC
## [PUT] {index}

### Description
Creates an index with optional settings and mappings.

### Method
PUT

### Endpoint
{index}

### Parameters
#### Path Parameters
- **index** (string) - Required - The name of the index to create.

#### Query Parameters
- **include_type_name** (boolean) - Optional - Whether a type should be expected in the body of the mappings.
- **wait_for_active_shards** (string) - Optional - Set the number of active shards to wait for before the operation returns.
- **timeout** (time) - Optional - Explicit operation timeout.
- **master_timeout** (time) - Optional - Specify timeout for connection to master.

#### Request Body
The configuration for the index (`settings` and `mappings`).

### Response
No response body is documented.

```

--------------------------------

### cat.templates

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Returns information about existing templates. Two variants are documented: one without a name parameter and one with a name path parameter.

```APIDOC
## GET _cat/templates

### Description
Returns information about existing templates.

### Method
GET

### Endpoint
_cat/templates

### Parameters
#### Query Parameters
- **format** (string) - Optional - a short version of the Accept header, e.g. json, yaml
- **local** (boolean) - Optional - Return local information, do not retrieve the state from master node (default: false)
- **master_timeout** (time) - Optional - Explicit operation timeout for connection to master node
- **h** (list) - Optional - Comma-separated list of column names to display
- **help** (boolean) - Optional - Return help information
- **s** (list) - Optional - Comma-separated list of column names or column aliases to sort by
- **v** (boolean) - Optional - Verbose mode. Display column headers
```

```APIDOC
## GET _cat/templates/{name}

### Description
Returns information about existing templates.

### Method
GET

### Endpoint
_cat/templates/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the template.

#### Query Parameters
- **format** (string) - Optional - a short version of the Accept header, e.g. json, yaml
- **local** (boolean) - Optional - Return local information, do not retrieve the state from master node (default: false)
- **master_timeout** (time) - Optional - Explicit operation timeout for connection to master node
- **h** (list) - Optional - Comma-separated list of column names to display
- **help** (boolean) - Optional - Return help information
- **s** (list) - Optional - Comma-separated list of column names or column aliases to sort by
- **v** (boolean) - Optional - Verbose mode. Display column headers
```

--------------------------------

### GET _upgrade and GET {index}/_upgrade

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

The _upgrade API is deprecated and will be removed. Use these requests to check the upgrade status of all indices or a specific index.

```http
GET _upgrade

```

```http
GET {index}/_upgrade

```

--------------------------------

### Get term vectors for a document in request body

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Retrieves term vectors for a document supplied in the request body. Use the GET or POST method with the index only.

```http
GET {index}/_termvectors
POST {index}/_termvectors

```

--------------------------------

### Get term vectors for a document by ID

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Retrieves term vectors for a specific document by ID. Use the GET or POST method with the index and document ID.

```http
GET {index}/_termvectors/{id}
POST {index}/_termvectors/{id}

```

--------------------------------

### GET {index}/{type}/_msearch/template

Source: https://opendistro.github.io/for-elasticsearch-docs/old/1.11.0/docs/elasticsearch/rest-api-reference

Executes several search template operations in one request for a specific index and type. Supports GET and POST methods.

```APIDOC
## [GET] {index}/{type}/_msearch/template

### Description
Allows to execute several search template operations in one request for a specific index and type.

### Method
GET

### Endpoint
{index}/{type}/_msearch/template

### Parameters
#### Path Parameters
- **index** (string) - Required - The index name.
- **type** (string) - Required - The document type.

#### URL Parameters
- **search_type** (enum) - Search operation type
- **typed_keys** (boolean) - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
- **max_concurrent_searches** (number) - Controls the maximum number of concurrent searches the multi search api will execute
- **rest_total_hits_as_int** (boolean) - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
- **ccs_minimize_roundtrips** (boolean) - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution

### Request Body
- **request definitions** (metadata-search request definition pairs) - Required - The request definitions (metadata-search request definition pairs), separated by newlines

```
Tokens:
Raw