A newer version is available. For the latest information, see the current release documentation.

›

API Reference

This document contains the entire list of the Elasticsearch API supported by the client, both OSS and commercial. The client is entirely licensed under Apache 2.0.

Elasticsearch exposes an HTTP layer to communicate with, and the client is a library that will help you do this. Because of this reason, you will see HTTP related parameters, such as body or headers.

Every API can accept two objects, the first contains all the parameters that will be sent to Elasticsearch, while the second includes the request specific parameters, such as timeouts, headers, and so on. In the first object, every parameter but the body will be sent via querystring or url parameter, depending on the API, and every unrecognized parameter will be sent as querystring.

// promise API
const result = await client.search({
  index: 'my-index',
  from: 20,
  size: 10,
  body: { foo: 'bar' }
}, {
  ignore: [404],
  maxRetries: 3
})

// callback API
client.search({
  index: 'my-index',
  from: 20,
  size: 10,
  body: { foo: 'bar' }
}, {
  ignore: [404],
  maxRetries: 3
}, (err, result) => {
  if (err) console.log(err)
})

In this document, you will find the reference of every parameter accepted by the querystring or the url. If you also need to send the body, you can find the documentation of its format in the reference link that is present along with every endpoint.

`pretty`	`boolean` - Pretty format the returned JSON response.
`human`	`boolean` - Return human readable values for statistics. Default: `true`
`error_trace` or `errorTrace`	`boolean` - Include the stack trace of returned errors.
`source`	`string` - The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
`filter_path` or `filterPath`	`list` - A comma-separated list of filters used to reduce the response.

`id`	`string` - The async search ID
`wait_for_completion_timeout` or `waitForCompletionTimeout`	`string` - Specify the time that the request should block waiting for the final response
`keep_alive` or `keepAlive`	`string` - Specify the time interval in which the results (partial or final) for this search will be available
`typed_keys` or `typedKeys`	`boolean` - Specify whether aggregation and suggester names should be prefixed by their respective types in the response

`index`	`string \| string[]` - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
`wait_for_completion_timeout` or `waitForCompletionTimeout`	`string` - Specify the time that the request should block waiting for the final response Default: `1s`
`keep_on_completion` or `keepOnCompletion`	`boolean` - Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)
`keep_alive` or `keepAlive`	`string` - Update the time interval in which the results (partial or final) for this search will be available Default: `5d`
`batched_reduce_size` or `batchedReduceSize`	`number` - The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available. Default: `5`
`request_cache` or `requestCache`	`boolean` - Specify if request cache should be used for this request or not, defaults to true
`analyzer`	`string` - The analyzer to use for the query string
`analyze_wildcard` or `analyzeWildcard`	`boolean` - Specify whether wildcard and prefix queries should be analyzed (default: false)
`default_operator` or `defaultOperator`	`'AND' \| 'OR'` - The default operator for query string query (AND or OR) Default: `OR`
`df`	`string` - The field to use as default where no field prefix is given in the query string
`explain`	`boolean` - Specify whether to return detailed information about score computation as part of a hit
`stored_fields` or `storedFields`	`string \| string[]` - A comma-separated list of stored fields to return as part of a hit
`docvalue_fields` or `docvalueFields`	`string \| string[]` - A comma-separated list of fields to return as the docvalue representation of a field for each hit
`from`	`number` - Starting offset (default: 0)
`ignore_unavailable` or `ignoreUnavailable`	`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed)
`ignore_throttled` or `ignoreThrottled`	`boolean` - Whether specified concrete, expanded or aliased indices should be ignored when throttled
`allow_no_indices` or `allowNoIndices`	`boolean` - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
`expand_wildcards` or `expandWildcards`	`'open' \| 'closed' \| 'hidden' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. Default: `open`
`lenient`	`boolean` - Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
`preference`	`string` - Specify the node or shard the operation should be performed on (default: random)
`q`	`string` - Query in the Lucene query string syntax
`routing`	`string \| string[]` - A comma-separated list of specific routing values
`search_type` or `searchType`	`'query_then_fetch' \| 'dfs_query_then_fetch'` - Search operation type
`size`	`number` - Number of hits to return (default: 10)
`sort`	`string \| string[]` - A comma-separated list of <field>:<direction> pairs
`_source`	`string \| string[]` - True or false to return the _source field or not, or a list of fields to return
`_source_excludes` or `_sourceExcludes`	`string \| string[]` - A list of fields to exclude from the returned _source field
`_source_includes` or `_sourceIncludes`	`string \| string[]` - A list of fields to extract and return from the _source field
`terminate_after` or `terminateAfter`	`number` - The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
`stats`	`string \| string[]` - Specific tag of the request for logging and statistical purposes
`suggest_field` or `suggestField`	`string` - Specify which field to use for suggestions
`suggest_mode` or `suggestMode`	`'missing' \| 'popular' \| 'always'` - Specify suggest mode Default: `missing`
`suggest_size` or `suggestSize`	`number` - How many suggestions to return in response
`suggest_text` or `suggestText`	`string` - The source text for which the suggestions should be returned
`timeout`	`string` - Explicit operation timeout
`track_scores` or `trackScores`	`boolean` - Whether to calculate and return scores even if they are not used for sorting
`track_total_hits` or `trackTotalHits`	`boolean` - Indicate if the number of documents that match the query should be tracked
`allow_partial_search_results` or `allowPartialSearchResults`	`boolean` - Indicate if an error should be returned if there is a partial search failure or timeout Default: `true`
`typed_keys` or `typedKeys`	`boolean` - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
`version`	`boolean` - Specify whether to return document version as part of a hit
`seq_no_primary_term` or `seqNoPrimaryTerm`	`boolean` - Specify whether to return sequence number and primary term of the last modification of each hit
`max_concurrent_shard_requests` or `maxConcurrentShardRequests`	`number` - The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests Default: `5`
`body`	`object` - The search definition using the Query DSL

`name`	`string` - the name of the autoscaling policy
`body`	`object` - the specification of the autoscaling policy

`index`	`string` - Default index for items which don’t provide one
`type`	`string` - Default document type for items which don’t provide one
`wait_for_active_shards` or `waitForActiveShards`	`string` - Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
`refresh`	`'true' \| 'false' \| 'wait_for'` - If `true` then refresh 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` (the default) then do nothing with refreshes.
`routing`	`string` - Specific routing value
`timeout`	`string` - Explicit operation timeout
`_source`	`string \| string[]` - True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
`_source_excludes` or `_sourceExcludes`	`string \| string[]` - Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
`_source_includes` or `_sourceIncludes`	`string \| string[]` - Default list of fields to extract and return from the _source field, can be overridden on each sub-request
`pipeline`	`string` - The pipeline id to preprocess incoming documents with
`require_alias` or `requireAlias`	`boolean` - Sets require_alias for all incoming documents. Defaults to unset (false)
`body`	`object` - The operation definition and data (action-data pairs), separated by newlines

`name`	`string \| string[]` - A comma-separated list of alias names to return
`format`	`string` - a short version of the Accept header, e.g. json, yaml
`local`	`boolean` - Return local information, do not retrieve the state from master node (default: false)
`h`	`string \| string[]` - Comma-separated list of column names to display
`help`	`boolean` - Return help information
`s`	`string \| string[]` - Comma-separated list of column names or column aliases to sort by
`v`	`boolean` - Verbose mode. Display column headers
`expand_wildcards` or `expandWildcards`	`'open' \| 'closed' \| 'hidden' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. Default: `all`

`node_id` or `nodeId`	`string \| string[]` - A comma-separated list of node IDs or names to limit the returned information
`format`	`string` - a short version of the Accept header, e.g. json, yaml
`bytes`	`'b' \| 'k' \| 'kb' \| 'm' \| 'mb' \| 'g' \| 'gb' \| 't' \| 'tb' \| 'p' \| 'pb'` - The unit in which to display byte values
`local`	`boolean` - Return local information, do not retrieve the state from master node (default: false)
`master_timeout` or `masterTimeout`	`string` - Explicit operation timeout for connection to master node
`h`	`string \| string[]` - Comma-separated list of column names to display
`help`	`boolean` - Return help information
`s`	`string \| string[]` - Comma-separated list of column names or column aliases to sort by
`v`	`boolean` - Verbose mode. Display column headers

`fields`	`string \| string[]` - A comma-separated list of fields to return the fielddata size
`format`	`string` - a short version of the Accept header, e.g. json, yaml
`bytes`	`'b' \| 'k' \| 'kb' \| 'm' \| 'mb' \| 'g' \| 'gb' \| 't' \| 'tb' \| 'p' \| 'pb'` - The unit in which to display byte values
`h`	`string \| string[]` - Comma-separated list of column names to display
`help`	`boolean` - Return help information
`s`	`string \| string[]` - Comma-separated list of column names or column aliases to sort by
`v`	`boolean` - Verbose mode. Display column headers

`id`	`string` - The ID of the data frame analytics to fetch
`allow_no_match` or `allowNoMatch`	`boolean` - Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)
`bytes`	`'b' \| 'k' \| 'kb' \| 'm' \| 'mb' \| 'g' \| 'gb' \| 't' \| 'tb' \| 'p' \| 'pb'` - The unit in which to display byte values
`format`	`string` - a short version of the Accept header, e.g. json, yaml
`h`	`string \| string[]` - Comma-separated list of column names to display
`help`	`boolean` - Return help information
`s`	`string \| string[]` - Comma-separated list of column names or column aliases to sort by
`time`	`'d' \| 'h' \| 'm' \| 's' \| 'ms' \| 'micros' \| 'nanos'` - The unit in which to display time values
`v`	`boolean` - Verbose mode. Display column headers

`datafeed_id` or `datafeedId`	`string` - The ID of the datafeeds stats to fetch
`allow_no_match` or `allowNoMatch`	`boolean` - Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
`allow_no_datafeeds` or `allowNoDatafeeds`	`boolean` - Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) WARNING: This parameter has been deprecated.
`format`	`string` - a short version of the Accept header, e.g. json, yaml
`h`	`string \| string[]` - Comma-separated list of column names to display
`help`	`boolean` - Return help information
`s`	`string \| string[]` - Comma-separated list of column names or column aliases to sort by
`time`	`'d' \| 'h' \| 'm' \| 's' \| 'ms' \| 'micros' \| 'nanos'` - The unit in which to display time values
`v`	`boolean` - Verbose mode. Display column headers

`job_id` or `jobId`	`string` - The ID of the jobs stats to fetch
`allow_no_match` or `allowNoMatch`	`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
`allow_no_jobs` or `allowNoJobs`	`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) WARNING: This parameter has been deprecated.
`bytes`	`'b' \| 'k' \| 'kb' \| 'm' \| 'mb' \| 'g' \| 'gb' \| 't' \| 'tb' \| 'p' \| 'pb'` - The unit in which to display byte values
`format`	`string` - a short version of the Accept header, e.g. json, yaml
`h`	`string \| string[]` - Comma-separated list of column names to display
`help`	`boolean` - Return help information
`s`	`string \| string[]` - Comma-separated list of column names or column aliases to sort by
`time`	`'d' \| 'h' \| 'm' \| 's' \| 'ms' \| 'micros' \| 'nanos'` - The unit in which to display time values
`v`	`boolean` - Verbose mode. Display column headers

`model_id` or `modelId`	`string` - The ID of the trained models stats to fetch
`allow_no_match` or `allowNoMatch`	`boolean` - Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) Default: `true`
`from`	`number` - skips a number of trained models
`size`	`number` - specifies a max number of trained models to get Default: `100`
`bytes`	`'b' \| 'k' \| 'kb' \| 'm' \| 'mb' \| 'g' \| 'gb' \| 't' \| 'tb' \| 'p' \| 'pb'` - The unit in which to display byte values
`format`	`string` - a short version of the Accept header, e.g. json, yaml
`h`	`string \| string[]` - Comma-separated list of column names to display
`help`	`boolean` - Return help information
`s`	`string \| string[]` - Comma-separated list of column names or column aliases to sort by
`time`	`'d' \| 'h' \| 'm' \| 's' \| 'ms' \| 'micros' \| 'nanos'` - The unit in which to display time values
`v`	`boolean` - Verbose mode. Display column headers

`repository`	`string \| string[]` - Name of repository from which to fetch the snapshot information
`format`	`string` - a short version of the Accept header, e.g. json, yaml
`ignore_unavailable` or `ignoreUnavailable`	`boolean` - Set to true to ignore unavailable snapshots
`master_timeout` or `masterTimeout`	`string` - Explicit operation timeout for connection to master node
`h`	`string \| string[]` - Comma-separated list of column names to display
`help`	`boolean` - Return help information
`s`	`string \| string[]` - Comma-separated list of column names or column aliases to sort by
`time`	`'d' \| 'h' \| 'm' \| 's' \| 'ms' \| 'micros' \| 'nanos'` - The unit in which to display time values
`v`	`boolean` - Verbose mode. Display column headers

`format`	`string` - a short version of the Accept header, e.g. json, yaml
`nodes`	`string \| string[]` - 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`	`string \| string[]` - A comma-separated list of actions that should be returned. Leave empty to return all.
`detailed`	`boolean` - Return detailed task information (default: false)
`parent_task_id` or `parentTaskId`	`string` - Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
`h`	`string \| string[]` - Comma-separated list of column names to display
`help`	`boolean` - Return help information
`s`	`string \| string[]` - Comma-separated list of column names or column aliases to sort by
`time`	`'d' \| 'h' \| 'm' \| 's' \| 'ms' \| 'micros' \| 'nanos'` - The unit in which to display time values
`v`	`boolean` - Verbose mode. Display column headers

`name`	`string` - A pattern that returned template names must match
`format`	`string` - a short version of the Accept header, e.g. json, yaml
`local`	`boolean` - Return local information, do not retrieve the state from master node (default: false)
`master_timeout` or `masterTimeout`	`string` - Explicit operation timeout for connection to master node
`h`	`string \| string[]` - Comma-separated list of column names to display
`help`	`boolean` - Return help information
`s`	`string \| string[]` - Comma-separated list of column names or column aliases to sort by
`v`	`boolean` - Verbose mode. Display column headers

`thread_pool_patterns` or `threadPoolPatterns`	`string \| string[]` - A comma-separated list of regular-expressions to filter the thread pools in the output
`format`	`string` - a short version of the Accept header, e.g. json, yaml
`size`	`'' \| 'k' \| 'm' \| 'g' \| 't' \| 'p'` - The multiplier in which to display values WARNING: This parameter has been deprecated.
`local`	`boolean` - Return local information, do not retrieve the state from master node (default: false)
`master_timeout` or `masterTimeout`	`string` - Explicit operation timeout for connection to master node
`h`	`string \| string[]` - Comma-separated list of column names to display
`help`	`boolean` - Return help information
`s`	`string \| string[]` - Comma-separated list of column names or column aliases to sort by
`v`	`boolean` - Verbose mode. Display column headers

`transform_id` or `transformId`	`string` - The id of the transform for which to get stats. _all or * implies all transforms
`from`	`number` - skips a number of transform configs, defaults to 0
`size`	`number` - specifies a max number of transforms to get, defaults to 100
`allow_no_match` or `allowNoMatch`	`boolean` - Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
`format`	`string` - a short version of the Accept header, e.g. json, yaml
`h`	`string \| string[]` - Comma-separated list of column names to display
`help`	`boolean` - Return help information
`s`	`string \| string[]` - Comma-separated list of column names or column aliases to sort by
`time`	`'d' \| 'h' \| 'm' \| 's' \| 'ms' \| 'micros' \| 'nanos'` - The unit in which to display time values
`v`	`boolean` - Verbose mode. Display column headers

`index`	`string` - The name of the follower index
`wait_for_active_shards` or `waitForActiveShards`	`string` - Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) Default: `0`
`body`	`object` - The name of the leader index and other optional ccr related parameters

`index`	`string` - the name of the leader index for which specified follower retention leases should be removed
`body`	`object` - the name and UUID of the follower index, the name of the cluster containing the follower index, and the alias from the perspective of that cluster for the remote cluster containing the leader index

`name`	`string` - The name of the auto follow pattern.
`body`	`object` - The specification of the auto follow pattern

API Reference

API Reference

Common parameters

asyncSearch.delete

asyncSearch.get

asyncSearch.status

asyncSearch.submit

autoscaling.deleteAutoscalingPolicy

autoscaling.getAutoscalingCapacity

autoscaling.getAutoscalingPolicy

autoscaling.putAutoscalingPolicy

bulk

cat.aliases

cat.allocation

cat.count

cat.fielddata

cat.health

cat.help

cat.indices

cat.master

cat.mlDataFrameAnalytics

cat.mlDatafeeds

cat.mlJobs

cat.mlTrainedModels

cat.nodeattrs

cat.nodes

cat.pendingTasks

cat.plugins

cat.recovery

cat.repositories

cat.segments

cat.shards

cat.snapshots

cat.tasks

cat.templates

cat.threadPool

cat.transforms

ccr.deleteAutoFollowPattern

ccr.follow

ccr.followInfo

ccr.followStats

ccr.forgetFollower

ccr.getAutoFollowPattern

ccr.pauseAutoFollowPattern

ccr.pauseFollow

ccr.putAutoFollowPattern

ccr.resumeAutoFollowPattern

ccr.resumeFollow

ccr.stats

ccr.unfollow

clearScroll

closePointInTime

cluster.allocationExplain

cluster.deleteComponentTemplate

cluster.deleteVotingConfigExclusions

cluster.existsComponentTemplate

cluster.getComponentTemplate

cluster.getSettings

cluster.health

cluster.pendingTasks

cluster.postVotingConfigExclusions

cluster.putComponentTemplate

cluster.putSettings

cluster.remoteInfo

cluster.reroute

cluster.state

cluster.stats

count

create

danglingIndices.deleteDanglingIndex

danglingIndices.importDanglingIndex

danglingIndices.listDanglingIndices

delete

deleteByQuery

deleteByQueryRethrottle

deleteScript

enrich.deletePolicy

enrich.executePolicy

enrich.getPolicy

enrich.putPolicy

`index`	`string` - The name of the follow index to resume following.
`body`	`object` - The name of the leader index and other optional ccr related parameters

`include_yes_decisions` or `includeYesDecisions`	`boolean` - Return YES decisions in explanation (default: false)
`include_disk_info` or `includeDiskInfo`	`boolean` - Return information about disk usage and shard sizes (default: false)
`body`	`object` - The index, shard, and primary flag to explain. Empty means explain a randomly-chosen unassigned shard

`name`	`string` - The name of the template
`timeout`	`string` - Explicit operation timeout
`master_timeout` or `masterTimeout`	`string` - Specify timeout for connection to master

`name`	`string \| string[]` - The comma separated names of the component templates
`master_timeout` or `masterTimeout`	`string` - Explicit operation timeout for connection to master node
`local`	`boolean` - Return local information, do not retrieve the state from master node (default: false)

`flat_settings` or `flatSettings`	`boolean` - Return settings in flat format (default: false)
`master_timeout` or `masterTimeout`	`string` - Explicit operation timeout for connection to master node
`timeout`	`string` - Explicit operation timeout
`include_defaults` or `includeDefaults`	`boolean` - Whether to return all default clusters setting.

`index`	`string \| string[]` - Limit the information returned to a specific index
`expand_wildcards` or `expandWildcards`	`'open' \| 'closed' \| 'hidden' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. Default: `all`
`level`	`'cluster' \| 'indices' \| 'shards'` - Specify the level of detail for returned information Default: `cluster`
`local`	`boolean` - Return local information, do not retrieve the state from master node (default: false)
`master_timeout` or `masterTimeout`	`string` - Explicit operation timeout for connection to master node
`timeout`	`string` - Explicit operation timeout
`wait_for_active_shards` or `waitForActiveShards`	`string` - Wait until the specified number of shards is active
`wait_for_nodes` or `waitForNodes`	`string` - Wait until the specified number of nodes is available
`wait_for_events` or `waitForEvents`	`'immediate' \| 'urgent' \| 'high' \| 'normal' \| 'low' \| 'languid'` - Wait until all currently queued events with the given priority are processed
`wait_for_no_relocating_shards` or `waitForNoRelocatingShards`	`boolean` - Whether to wait until there are no relocating shards in the cluster
`wait_for_no_initializing_shards` or `waitForNoInitializingShards`	`boolean` - Whether to wait until there are no initializing shards in the cluster
`wait_for_status` or `waitForStatus`	`'green' \| 'yellow' \| 'red'` - Wait until cluster is in a specific state

`node_ids` or `nodeIds`	`string` - A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_names.
`node_names` or `nodeNames`	`string` - A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_ids.
`timeout`	`string` - Explicit operation timeout Default: `30s`

`name`	`string` - The name of the template
`create`	`boolean` - Whether the index template should only be added if new or can also replace an existing one
`timeout`	`string` - Explicit operation timeout
`master_timeout` or `masterTimeout`	`string` - Specify timeout for connection to master
`body`	`object` - The template definition

`dry_run` or `dryRun`	`boolean` - Simulate the operation only and return the resulting state
`explain`	`boolean` - Return an explanation of why the commands can or cannot be executed
`retry_failed` or `retryFailed`	`boolean` - Retries allocation of shards that are blocked due to too many subsequent allocation failures
`metric`	`string \| string[]` - Limit the information returned to the specified metrics. Defaults to all but metadata
`master_timeout` or `masterTimeout`	`string` - Explicit operation timeout for connection to master node
`timeout`	`string` - Explicit operation timeout
`body`	`object` - The definition of `commands` to perform (`move`, `cancel`, `allocate`)

`id`	`string` - Document ID
`index`	`string` - The name of the index
`type`	`string` - The type of the document WARNING: This parameter has been deprecated.
`wait_for_active_shards` or `waitForActiveShards`	`string` - Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
`refresh`	`'true' \| 'false' \| 'wait_for'` - If `true` then refresh 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` (the default) then do nothing with refreshes.
`routing`	`string` - Specific routing value
`timeout`	`string` - Explicit operation timeout
`version`	`number` - Explicit version number for concurrency control
`version_type` or `versionType`	`'internal' \| 'external' \| 'external_gte'` - Specific version type
`pipeline`	`string` - The pipeline id to preprocess incoming documents with
`body`	`object` - The document