/elasticsearch-indices | Type: Application | PCID required: Yes
Tools
elasticsearch_indices_add_block
Add an index block Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you are adding blocks to. To allow the adding of blocks to indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. You can update this setting in the elasticsearch.yml file or by using the cluster update settings API. |
block | string | Yes | — | The block type to add to the index. Supported values include: - metadata: Disable metadata changes, such as closing the index. - read: Disable read operations. - read_only: Disable write operations and metadata changes. - write: Disable write operations. However, metadata changes are still allowed. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
master_timeout | string | No | — | The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout. |
timeout | string | No | — | The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to -1 to indicate that the request should never timeout. |
elasticsearch_indices_analyze
Get tokens from text analysis Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string | Yes | — | Index used to derive the analyzer. If specified, the analyzer or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer. |
analyzer | string | No | — | The name of the analyzer that should be applied to the provided text. This could be a built-in analyzer, or an analyzer that’s been configured in the index. |
attributes | string[] | No | — | Array of token attributes used to filter the output of the explain parameter. |
char_filter | any[] | No | — | Array of character filters used to preprocess characters before the tokenizer. |
explain | boolean | No | — | If true, the response includes token attributes and additional details. |
field | object | No | — | Field used to derive the analyzer. To use this parameter, you must specify an index. If specified, the analyzer parameter overrides this value. |
filter | any[] | No | — | Array of token filters used to apply after the tokenizer. |
normalizer | string | No | — | Normalizer to use to convert text into a single token. |
text | object | No | — | Text to analyze. If an array of strings is provided, it is analyzed as a multi-value field. |
tokenizer | object | No | — | Tokenizer to use to convert text into tokens. |
elasticsearch_indices_clear_cache
Clear the cache Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
fielddata | boolean | No | — | If true, clears the fields cache. Use the fields parameter to clear the cache of specific fields only. |
fields | string[] | No | — | Comma-separated list of field names used to limit the fielddata parameter. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
query | boolean | No | — | If true, clears the query cache. |
request | boolean | No | — | If true, clears the request cache. |
elasticsearch_indices_clone
Clone an index Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string | Yes | — | Name of the source index to clone. |
target | string | Yes | — | Name of the target index to create. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
timeout | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
wait_for_active_shards | object | No | — | The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). |
aliases | object | No | — | Aliases for the resulting index. |
settings | object | No | — | Configuration options for the target index. |
elasticsearch_indices_close
Close an index Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list or wildcard expression of index names used to limit the request. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
timeout | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
wait_for_active_shards | object | No | — | The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). |
elasticsearch_indices_cluster_delete_component_template
Delete component templates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string[] | Yes | — | Comma-separated list or wildcard expression of component template names used to limit the request. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
timeout | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
elasticsearch_indices_cluster_get_component_template
Get component templates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Name of component template to retrieve. Wildcard (*) expressions are supported. |
flat_settings | boolean | No | — | If true, returns settings in flat format. |
settings_filter | string[] | No | — | Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys |
include_defaults | boolean | No | — | Return all default configurations for the component template |
local | boolean | No | — | If true, the request retrieves information from the local node only. If false, information is retrieved from the master node. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
elasticsearch_indices_cluster_put_component_template
Create or update a component template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Name of the component template to create. Elasticsearch includes the following built-in component templates: logs-mappings; logs-settings; metrics-mappings; metrics-settings;synthetics-mapping; synthetics-settings. Elastic Agent uses these templates to configure backing indices for its data streams. If you use Elastic Agent and want to overwrite one of these templates, set the version for your replacement template higher than the current version. If you don’t use Elastic Agent and want to disable all built-in component and index templates, set stack.templates.enabled to false using the cluster update settings API. |
create | boolean | No | — | If true, this request cannot replace or update existing component templates. |
cause | string | No | — | User defined reason for create the component template. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
_meta | object | No | — | Optional user metadata about the component template. It may have any contents. This map is not automatically generated by Elasticsearch. This information is stored in the cluster state, so keeping it short is preferable. To unset _meta, replace the template without specifying this information. |
deprecated | boolean | No | — | Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning. |
template | object | Yes | — | The template to be applied which includes mappings, settings, or aliases configuration. |
version | object | No | — | Version number used to manage component templates externally. This number isn’t automatically generated or incremented by Elasticsearch. To unset a version, replace the template without specifying a version. |
elasticsearch_indices_create
Create an index Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string | Yes | — | Name of the index you wish to create. Index names must meet the following criteria: * Lowercase only * Cannot include \, /, *, ?, ", <, >, |, (space character), ,, or # * Indices prior to 7.0 could contain a colon (:), but that has been deprecated and will not be supported in later versions * Cannot start with -, _, or + * Cannot be . or .. * Cannot be longer than 255 bytes (note thtat it is bytes, so multi-byte characters will reach the limit faster) * Names starting with . are deprecated, except for hidden indices and internal indices managed by plugins |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
timeout | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
wait_for_active_shards | object | No | — | The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). |
aliases | object | No | — | Aliases for the index. |
mappings | object | No | — | Mapping for fields in the index. If specified, this mapping can include: - Field names - Field data types - Mapping parameters |
settings | object | No | — | Configuration options for the index. |
elasticsearch_indices_delete
Delete indices Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (*) or _all. To use wildcards or _all, set the action.destructive_requires_name cluster setting to false. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
timeout | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
elasticsearch_indices_delete_alias
Delete an alias Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams or indices used to limit the request. Supports wildcards (*). |
name | string[] | Yes | — | Comma-separated list of aliases to remove. Supports wildcards (*). To remove all aliases, use * or _all. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
timeout | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
elasticsearch_indices_delete_index_template
Delete an index template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string[] | Yes | — | Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
timeout | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
elasticsearch_indices_disk_usage
Analyze the index disk usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams, indices, and aliases used to limit the request. It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
flush | boolean | No | — | If true, the API performs a flush before analysis. If false, the response may not include uncommitted data. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
run_expensive_tasks | boolean | No | — | Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to true. |
elasticsearch_indices_flush
Flush data streams or indices Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (*). To flush all data streams and indices, omit this parameter or use * or _all. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
force | boolean | No | — | If true, the request forces a flush even if there are no changes to commit to the index. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
wait_if_ongoing | boolean | No | — | If true, the flush operation blocks until execution when another flush operation is running. If false, Elasticsearch returns an error if you request a flush when another flush operation is running. |
elasticsearch_indices_forcemerge
Force a merge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | A comma-separated list of index names; use _all or empty string to perform the operation on all indices |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Whether to expand wildcard expression to concrete indices that are open, closed or both. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
flush | boolean | No | — | Specify whether the index should be flushed after performing the operation |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
max_num_segments | number | No | — | The number of segments the index should be merged into (default: dynamic) |
only_expunge_deletes | boolean | No | — | Specify whether the operation should only expunge deleted documents |
wait_for_completion | boolean | No | — | Should the request wait until the force merge is completed |
elasticsearch_indices_get
Get index information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
flat_settings | boolean | No | — | If true, returns settings in flat format. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
include_defaults | boolean | No | — | If true, return all default settings in the response. |
local | boolean | No | — | If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
features | string[] | No | — | Return only information on specified index features Supported values include: aliases, mappings, settings |
elasticsearch_indices_get_alias
Get aliases Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams or indices used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. |
name | string[] | Yes | — | Comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
elasticsearch_indices_get_field_mapping
Get mapping definitions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. |
fields | string[] | Yes | — | Comma-separated list or wildcard expression of fields used to limit returned information. Supports wildcards (*). |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
include_defaults | boolean | No | — | If true, return all default settings in the response. |
elasticsearch_indices_get_index_template
Get index templates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Name of index template to retrieve. Wildcard (*) expressions are supported. |
local | boolean | No | — | If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. |
flat_settings | boolean | No | — | If true, returns settings in flat format. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
include_defaults | boolean | No | — | If true, returns all relevant default configurations for the index template. |
elasticsearch_indices_get_mapping
Get mapping definitions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
local | boolean | No | — | If true, the request retrieves information from the local node only. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
elasticsearch_indices_get_settings
Get index settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. |
name | string[] | Yes | — | Comma-separated list or wildcard expression of settings to retrieve. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
flat_settings | boolean | No | — | If true, returns settings in flat format. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
include_defaults | boolean | No | — | If true, return all default settings in the response. |
local | boolean | No | — | If true, the request retrieves information from the local node only. If false, information is retrieved from the master node. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
elasticsearch_indices_open
Open a closed index Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). By default, you must explicitly name the indices you using to limit the request. To limit a request using _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. You can update this setting in the elasticsearch.yml file or using the cluster update settings API. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
timeout | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
wait_for_active_shards | object | No | — | The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). |
elasticsearch_indices_put_alias
Create or update an alias Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams or indices to add. Supports wildcards (*). Wildcard patterns that match both data streams and indices return an error. |
name | string | Yes | — | Alias to update. If the alias doesn’t exist, the request creates it. Index alias names support date math. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
timeout | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
filter | object | No | — | Query used to limit documents the alias can access. |
index_routing | string | No | — | Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations. Data stream aliases don’t support this parameter. |
is_write_index | boolean | No | — | If true, sets the write index or data stream for the alias. If an alias points to multiple indices or data streams and is_write_index isn’t set, the alias rejects write requests. If an index alias points to one index and is_write_index isn’t set, the index automatically acts as the write index. Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. |
routing | string | No | — | Value used to route indexing and search operations to a specific shard. Data stream aliases don’t support this parameter. |
search_routing | string | No | — | Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations. Data stream aliases don’t support this parameter. |
elasticsearch_indices_put_index_template
Create or update an index template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Index or template name |
create | boolean | No | — | If true, this request cannot replace or update existing index templates. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
cause | string | No | — | User defined reason for creating or updating the index template |
_meta | object | No | — | Optional user metadata about the index template. It may have any contents. It is not automatically generated or used by Elasticsearch. This user-defined object is stored in the cluster state, so keeping it short is preferable To unset the metadata, replace the template without specifying it. |
allow_auto_create | boolean | No | — | This setting overrides the value of the action.auto_create_index cluster setting. If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. |
composed_of | string[] | No | — | An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. |
data_stream | object | No | — | If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a data_stream object. |
deprecated | boolean | No | — | Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning. |
ignore_missing_component_templates | string[] | No | — | The configuration option ignore_missing_component_templates can be used when an index template references a component template that might not exist |
index_patterns | object | No | — | Array of wildcard (*) expressions used to match the names of data streams and indices during creation. |
priority | number | No | — | Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch. |
template | object | No | — | Template to be applied. It may optionally include an aliases, mappings, or settings configuration. |
version | object | No | — | Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch. External systems can use these version numbers to simplify template management. To unset a version, replace the template without specifying one. |
elasticsearch_indices_put_mapping
Update field mappings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | A comma-separated list of index names the mapping should be added to (supports wildcards). Use _all or omit to add the mapping on all indices. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
timeout | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
write_index_only | boolean | No | — | If true, the mappings are applied only to the current write index for the target. |
_field_names | object | No | — | Control whether field names are enabled for the index. |
_meta | object | No | — | A mapping type can have custom meta data associated with it. These are not used at all by Elasticsearch, but can be used to store application-specific metadata. |
_routing | object | No | — | Enable making a routing value required on indexed documents. |
_source | object | No | — | Control whether the _source field is enabled on the index. |
date_detection | boolean | No | — | Controls whether dynamic date detection is enabled. |
dynamic | object | No | — | Controls whether new fields are added dynamically. |
dynamic_date_formats | string[] | No | — | If date detection is enabled then new string fields are checked against ‘dynamic_date_formats’ and if the value matches then a new date field is added instead of string. |
dynamic_templates | object[] | No | — | Specify dynamic templates for the mapping. |
numeric_detection | boolean | No | — | Automatically map strings into numeric data types for all fields. |
properties | object | No | — | Mapping for a field. For new fields, this mapping can include: - Field name - Field data type - Mapping parameters |
runtime | object | No | — | Mapping of runtime fields for the index. |
elasticsearch_indices_put_settings
Update index settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
flat_settings | boolean | No | — | If true, returns settings in flat format. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
preserve_existing | boolean | No | — | If true, existing index settings remain unchanged. |
reopen | boolean | No | — | Whether to close and reopen the index to apply non-dynamic settings. If set to true the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. |
timeout | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
body | object | Yes | — | Request body |
elasticsearch_indices_recovery
Get index recovery information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. |
active_only | boolean | No | — | If true, the response only includes ongoing shard recoveries. |
detailed | boolean | No | — | If true, the response includes detailed information about shard recoveries. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
elasticsearch_indices_refresh
Refresh an index Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
elasticsearch_indices_remove_block
Remove an index block Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you are removing blocks from. To allow the removal of blocks from indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. You can update this setting in the elasticsearch.yml file or by using the cluster update settings API. |
block | string | Yes | — | The block type to remove from the index. Supported values include: - metadata: Disable metadata changes, such as closing the index. - read: Disable read operations. - read_only: Disable write operations and metadata changes. - write: Disable write operations. However, metadata changes are still allowed. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
master_timeout | string | No | — | The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout. |
timeout | string | No | — | The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to -1 to indicate that the request should never timeout. |
elasticsearch_indices_resolve_cluster
Resolve the cluster Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string[] | Yes | — | A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>:<name> syntax. Index and cluster exclusions (e.g., -cluster1:*) are also supported. If no index expression is specified, information about all remote clusters configured on the local cluster is returned without doing any index matching |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
ignore_throttled | boolean | No | — | If true, concrete, expanded, or aliased indices are ignored when frozen. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression. |
timeout | string | No | — | The maximum time to wait for remote clusters to respond. If a remote cluster does not respond within this timeout period, the API response will show the cluster as not connected and include an error message that the request timed out. The default timeout is unset and the query can take as long as the networking layer is configured to wait for remote clusters that are not responding (typically 30 seconds). |
elasticsearch_indices_resolve_index
Resolve indices Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string[] | Yes | — | Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>:<name> syntax. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
mode | string[] | No | — | Filter indices by index mode - standard, lookup, time_series, etc. Comma-separated list of IndexMode. Empty means no filter. Supported values include: standard, time_series, logsdb, lookup |
body | object | No | — | Request body |
elasticsearch_indices_rollover
Roll over to a new index Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
alias | string | Yes | — | Name of the data stream or index alias to roll over. |
new_index | string | Yes | — | Name of the index to create. Supports date math. Data streams do not support this parameter. |
dry_run | boolean | No | — | If true, checks whether the current index satisfies the specified conditions but does not perform a rollover. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
timeout | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
wait_for_active_shards | object | No | — | The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). |
lazy | boolean | No | — | If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams. |
aliases | object | No | — | Aliases for the target index. Data streams do not support this parameter. |
conditions | object | No | — | Conditions for the rollover. If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions. If this parameter is not specified, Elasticsearch performs the rollover unconditionally. If conditions are specified, at least one of them must be a max_* condition. The index will rollover if any max_* condition is satisfied and all min_* conditions are satisfied. |
mappings | object | No | — | Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping paramaters. |
settings | object | No | — | Configuration options for the index. Data streams do not support this parameter. |
elasticsearch_indices_segments
Get index segments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
elasticsearch_indices_shard_stores
Get index shard stores Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | List of data streams, indices, and aliases used to limit the request. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
status | string[] | No | — | List of shard health statuses used to limit the request. Supported values include: - green: The primary shard and all replica shards are assigned. - yellow: One or more replica shards are unassigned. - red: The primary shard is unassigned. - all: Return all shards, regardless of health status. |
elasticsearch_indices_shrink
Shrink an index Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string | Yes | — | Name of the source index to shrink. |
target | string | Yes | — | Name of the target index to create. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
timeout | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
wait_for_active_shards | object | No | — | The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). |
aliases | object | No | — | The key is the alias name. Index alias names support date math. |
settings | object | No | — | Configuration options for the target index. |
elasticsearch_indices_split
Split an index Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string | Yes | — | Name of the source index to split. |
target | string | Yes | — | Name of the target index to create. |
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
timeout | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
wait_for_active_shards | object | No | — | The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). |
aliases | object | No | — | Aliases for the resulting index. |
settings | object | No | — | Configuration options for the target index. |
elasticsearch_indices_stats
Get index statistics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | A comma-separated list of index names; use _all or empty string to perform the operation on all indices |
metric | string[] | Yes | — | Comma-separated list of metrics used to limit the request. Supported values include: - _all: Return all statistics. - store: Size of the index in byte units. - indexing: Indexing statistics. - get: Get statistics, including missing stats. - search: Search statistics including suggest statistics. You can include statistics for custom groups by adding an extra groups parameter (search operations can be associated with one or more groups). The groups parameter accepts a comma-separated list of group names. Use _all to return statistics for all groups. - merge: Merge statistics. - flush: Flush statistics. - refresh: Refresh statistics. - query_cache: Query cache statistics. - fielddata: Fielddata statistics. - docs: Number of documents and deleted docs not yet merged out. Index refreshes can affect this statistic. - warmer: Index warming statistics. - completion: Completion suggester statistics. - segments: Memory use of all open segments. If the include_segment_file_sizes parameter is true, this metric includes the aggregated disk usage of each Lucene index file. - translog: Translog statistics. - request_cache: Shard request cache statistics. - recovery: Recovery statistics. - bulk: Bulk operations statistics. - shard_stats: Shard statistics, including the total number of shards. - mappings: Mapping statistics, including the total count and estimated overhead. - dense_vector: Total number of dense vectors indexed. Index refreshes can affect this statistic. - sparse_vector: Total number of sparse vectors indexed. Index refreshes can affect this statistic. |
completion_fields | string[] | No | — | Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
fielddata_fields | string[] | No | — | Comma-separated list or wildcard expressions of fields to include in fielddata statistics. |
fields | string[] | No | — | Comma-separated list or wildcard expressions of fields to include in the statistics. |
forbid_closed_indices | boolean | No | — | If true, statistics are not collected from closed indices. |
groups | string[] | No | — | Comma-separated list of search groups to include in the search statistics. |
include_segment_file_sizes | boolean | No | — | If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). |
include_unloaded_segments | boolean | No | — | If true, the response includes information from segments that are not loaded into memory. |
level | string | No | — | Indicates whether statistics are aggregated at the cluster, indices, or shards level. |
elasticsearch_indices_update_aliases
Create or update an alias Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
master_timeout | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
timeout | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
actions | object[] | No | — | Actions to perform. |
elasticsearch_indices_validate_query
Validate a query Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
index | string[] | Yes | — | Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*). To search all data streams or indices, omit this parameter or use * or _all. |
allow_no_indices | boolean | No | — | A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result. |
all_shards | boolean | No | — | If true, the validation is executed on all shards instead of one random shard per index. |
analyzer | string | No | — | Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified. |
analyze_wildcard | boolean | No | — | If true, wildcard and prefix queries are analyzed. |
default_operator | string | No | — | The default operator for query string query: and or or. |
df | string | No | — | Field to use as default where no field prefix is given in the query string. This parameter can only be used when the q query string parameter is specified. |
expand_wildcards | string[] | No | — | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Supported values include: - all: Match any data stream or index, including hidden ones. - open: Match open, non-hidden indices. Also matches any non-hidden data stream. - closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. |
explain | boolean | No | — | If true, the response returns detailed information if an error has occurred. |
ignore_unavailable | boolean | No | — | If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored. |
lenient | boolean | No | — | If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. |
rewrite | boolean | No | — | If true, returns a more detailed explanation showing the actual Lucene query that will be executed. |
q | string | No | — | Query in the Lucene query string syntax. |
query | object | No | — | Query in the Lucene query string syntax. |