« Client configuration Breaking changes coming from the old client »

API Referenceedit

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.

Common parametersedit

Parameters that are accepted by all API endpoints.

`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.

`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

`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

`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

`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 the first 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

`index_uuid` or `indexUuid`	`string` - The UUID of the dangling index
`accept_data_loss` or `acceptDataLoss`	`boolean` - Must be set to true in order to delete the dangling index
`timeout`	`string` - Explicit operation timeout
`master_timeout` or `masterTimeout`	`string` - Specify timeout for connection to master

`id`	`string` - The 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 delete 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
`if_seq_no` or `ifSeqNo`	`number` - only perform the delete operation if the last operation that has changed the document has the specified sequence number
`if_primary_term` or `ifPrimaryTerm`	`number` - only perform the delete operation if the last operation that has changed the document has the specified primary term
`version`	`number` - Explicit version number for concurrency control
`version_type` or `versionType`	`'internal' \| 'external' \| 'external_gte' \| 'force'` - Specific version type

`task_id` or `taskId`	`string` - The task id to rethrottle
`requests_per_second` or `requestsPerSecond`	`number` - The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.

API Referenceedit

Common parametersedit

bulkedit

cat.aliasesedit

cat.allocationedit

cat.countedit

cat.fielddataedit

cat.healthedit

cat.helpedit

cat.indicesedit

cat.masteredit

cat.nodeattrsedit

cat.nodesedit

cat.pendingTasksedit

cat.pluginsedit

cat.recoveryedit

cat.repositoriesedit

cat.segmentsedit

cat.shardsedit

cat.snapshotsedit

cat.tasksedit

cat.templatesedit

cat.threadPooledit

clearScrolledit

cluster.allocationExplainedit

cluster.deleteComponentTemplateedit

cluster.deleteVotingConfigExclusionsedit

cluster.existsComponentTemplateedit

cluster.getComponentTemplateedit

cluster.getSettingsedit

cluster.healthedit

cluster.pendingTasksedit

cluster.postVotingConfigExclusionsedit

cluster.putComponentTemplateedit

cluster.putSettingsedit

cluster.remoteInfoedit

cluster.rerouteedit

cluster.stateedit

cluster.statsedit

countedit

createedit

danglingIndices.deleteDanglingIndexedit

danglingIndices.importDanglingIndexedit

danglingIndices.listDanglingIndicesedit

deleteedit

deleteByQueryedit

deleteByQueryRethrottleedit

deleteScriptedit

existsedit

existsSourceedit

explainedit

fieldCapsedit

getedit

getScriptedit

getScriptContextedit

getScriptLanguagesedit

getSourceedit

indexedit

indices.addBlockedit

indices.analyzeedit

indices.clearCacheedit

indices.cloneedit

indices.closeedit

indices.createedit

indices.deleteedit

indices.deleteAliasedit

indices.deleteIndexTemplateedit

indices.deleteTemplateedit

indices.existsedit

indices.existsAliasedit

indices.existsIndexTemplateedit

indices.existsTemplateedit

indices.existsTypeedit

indices.flushedit

indices.flushSyncededit

indices.forcemergeedit

indices.getedit

indices.getAliasedit

indices.getFieldMappingedit

indices.getIndexTemplateedit

`id`	`string` - Script ID
`timeout`	`string` - Explicit operation timeout
`master_timeout` or `masterTimeout`	`string` - Specify timeout for connection to master

`index`	`string \| string[]` - A comma separated list of indices to add a block to
`block`	`string` - The block to add (one of read, write, read_only or metadata)
`timeout`	`string` - Explicit operation timeout
`master_timeout` or `masterTimeout`	`string` - Specify timeout for connection to master
`ignore_unavailable` or `ignoreUnavailable`	`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed)
`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`

`index`	`string` - The name of the index to scope the operation
`body`	`object` - Define analyzer/tokenizer parameters and the text on which the analysis should be performed

`index`	`string \| string[]` - A comma-separated list of index name to limit the operation
`fielddata`	`boolean` - Clear field data
`fields`	`string \| string[]` - A comma-separated list of fields to clear when using the `fielddata` parameter (default: all)
`query`	`boolean` - Clear query caches
`ignore_unavailable` or `ignoreUnavailable`	`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed)
`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`
`request`	`boolean` - Clear request cache

`index`	`string` - The name of the source index to clone
`target`	`string` - The name of the target index to clone into
`timeout`	`string` - Explicit operation timeout
`master_timeout` or `masterTimeout`	`string` - Specify timeout for connection to master
`wait_for_active_shards` or `waitForActiveShards`	`string` - Set the number of active shards to wait for on the cloned index before the operation returns.
`body`	`object` - The configuration for the target index (`settings` and `aliases`)

`index`	`string` - The name of the index
`include_type_name` or `includeTypeName`	`boolean` - Whether a type should be expected in the body of the mappings.
`wait_for_active_shards` or `waitForActiveShards`	`string` - Set the number of active shards to wait for before the operation returns.
`timeout`	`string` - Explicit operation timeout
`master_timeout` or `masterTimeout`	`string` - Specify timeout for connection to master
`body`	`object` - The configuration for the index (`settings` and `mappings`)

`index`	`string \| string[]` - A comma-separated list of index names; use `_all` or empty string for all indices
`force`	`boolean` - Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
`wait_if_ongoing` or `waitIfOngoing`	`boolean` - If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running.
`ignore_unavailable` or `ignoreUnavailable`	`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed)
`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`

`index`	`string \| string[]` - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`flush`	`boolean` - Specify whether the index should be flushed after performing the operation (default: true)
`ignore_unavailable` or `ignoreUnavailable`	`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed)
`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`
`max_num_segments` or `maxNumSegments`	`number` - The number of segments the index should be merged into (default: dynamic)
`only_expunge_deletes` or `onlyExpungeDeletes`	`boolean` - Specify whether the operation should only expunge deleted documents

`index`	`string \| string[]` - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`detailed`	`boolean` - Whether to display detailed information about shard recovery
`active_only` or `activeOnly`	`boolean` - Display only those recoveries that are currently on-going

`alias`	`string` - The name of the alias to rollover
`new_index` or `newIndex`	`string` - The name of the rollover index
`include_type_name` or `includeTypeName`	`boolean` - Whether a type should be included in the body of the mappings.
`timeout`	`string` - Explicit operation timeout
`dry_run` or `dryRun`	`boolean` - If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false
`master_timeout` or `masterTimeout`	`string` - Specify timeout for connection to master
`wait_for_active_shards` or `waitForActiveShards`	`string` - Set the number of active shards to wait for on the newly created rollover index before the operation returns.
`body`	`object` - The conditions that needs to be met for executing rollover