@elastic/schemas 0.5.0 → 0.5.1

package/lib/cjs/es/json/indices.downsample.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.downsample", "type": "object", "properties": { "config": { "$ref": "./indices._types.json#/$defs/indices._types__DownsampleConfig", "x-found-in": "body" }, "index": { "type": "string", "description": "Name of the time series index to downsample.", "x-found-in": "path" }, "target_index": { "type": "string", "description": "Name of the index to create.", "x-found-in": "path" } }, "required": ["index", "target_index"], "description": "Downsample an index.\n\nDownsamples a time series (TSDS) index and reduces its size by keeping the last value or by pre-aggregating metrics:\n\n- When running in `aggregate` mode, it pre-calculates and stores statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`)\nfor each metric field grouped by a configured time interval and their dimensions.\n- When running in `last_value` mode, it keeps the last value for each metric in the configured interval and their dimensions.\n\nFor example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.\nAll documents within an hour interval are summarized and stored as a single document in the downsample index.\n\nNOTE: Only indices in a time series data stream are supported.\nNeither field nor document level security can be defined on the source index.\nThe source index must be read-only (`index.blocks.write: true`)." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.downsample", "description": "Downsample an index.\n\nDownsamples a time series (TSDS) index and reduces its size by keeping the last value or by pre-aggregating metrics:\n\n- When running in `aggregate` mode, it pre-calculates and stores statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`)\nfor each metric field grouped by a configured time interval and their dimensions.\n- When running in `last_value` mode, it keeps the last value for each metric in the configured interval and their dimensions.\n\nFor example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.\nAll documents within an hour interval are summarized and stored as a single document in the downsample index.\n\nNOTE: Only indices in a time series data stream are supported.\nNeither field nor document level security can be defined on the source index.\nThe source index must be read-only (`index.blocks.write: true`).", "x-api": { "id": "indices.downsample", "name": "downsample", "namespace": "indices" }, "x-method": "POST", "x-path": "/{index}/_downsample/{target_index}", "x-urls": [{ "path": "/{index}/_downsample/{target_index}", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.7.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "config": { "$ref": "./indices._types.json#/$defs/indices._types__DownsampleConfig", "x-found-in": "body", "x-body-root": true }, "index": { "type": "string", "description": "Name of the time series index to downsample.", "x-found-in": "path" }, "target_index": { "type": "string", "description": "Name of the index to create.", "x-found-in": "path" } }, "required": ["index", "target_index"] }

package/lib/cjs/es/json/indices.exists.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.exists", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If `true`, return all default settings in the response.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`).", "x-found-in": "path" } }, "required": ["index"], "description": "Check indices.\n\nCheck if one or more indices, index aliases, or data streams exist." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.exists", "description": "Check indices.\n\nCheck if one or more indices, index aliases, or data streams exist.", "x-api": { "id": "indices.exists", "name": "exists", "namespace": "indices" }, "x-method": "HEAD", "x-path": "/{index}", "x-urls": [{ "path": "/{index}", "methods": ["HEAD"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If `true`, return all default settings in the response.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`).", "x-found-in": "path" } }, "required": ["index"] }

package/lib/cjs/es/json/indices.exists_alias.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.exists_alias", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list of aliases to check. Supports wildcards (`*`).", "x-found-in": "path" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "required": ["name"], "description": "Check aliases.\n\nCheck if one or more data stream or index aliases exist." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.exists_alias", "description": "Check aliases.\n\nCheck if one or more data stream or index aliases exist.", "x-api": { "id": "indices.exists_alias", "name": "exists-alias", "namespace": "indices" }, "x-method": "HEAD", "x-path": "/{index}/_alias/{name}", "x-urls": [{ "path": "/_alias/{name}", "methods": ["HEAD"] }, { "path": "/{index}/_alias/{name}", "methods": ["HEAD"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list of aliases to check. Supports wildcards (`*`).", "x-found-in": "path" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/indices.exists_index_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.exists_index_template", "type": "object", "properties": { "local": { "type": "boolean", "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", "x-found-in": "query" }, "flat_settings": { "type": "boolean", "description": "If true, returns settings in flat format.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "name": { "type": "string", "description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", "x-found-in": "path" } }, "required": ["name"], "description": "Check index templates.\n\nCheck whether index templates exist." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.exists_index_template", "description": "Check index templates.\n\nCheck whether index templates exist.", "x-api": { "id": "indices.exists_index_template", "name": "exists-index-template", "namespace": "indices" }, "x-method": "HEAD", "x-path": "/_index_template/{name}", "x-urls": [{ "path": "/_index_template/{name}", "methods": ["HEAD"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "local": { "type": "boolean", "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", "x-found-in": "query" }, "flat_settings": { "type": "boolean", "description": "If true, returns settings in flat format.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "name": { "type": "string", "description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/indices.exists_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.exists_template", "type": "object", "properties": { "flat_settings": { "type": "boolean", "description": "Indicates whether to use a flat format for the response.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "Indicates whether to get information from the local node only.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of index template names used to limit the request.\nWildcard (`*`) expressions are supported.", "x-found-in": "path" } }, "required": ["name"], "description": "Check existence of index templates.\n\nGet information about whether index templates exist.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.exists_template", "description": "Check existence of index templates.\n\nGet information about whether index templates exist.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.", "x-api": { "id": "indices.exists_template", "name": "exists-template", "namespace": "indices" }, "x-method": "HEAD", "x-path": "/_template/{name}", "x-urls": [{ "path": "/_template/{name}", "methods": ["HEAD"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "flat_settings": { "type": "boolean", "description": "Indicates whether to use a flat format for the response.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "Indicates whether to get information from the local node only.", "x-found-in": "query", "x-deprecated": { "since": "9.0.0", "description": "This parameter has no effect, is now deprecated, and will be removed in a future version." } }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of index template names used to limit the request.\nWildcard (`*`) expressions are supported.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/indices.explain_data_lifecycle.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.explain_data_lifecycle", "type": "object", "properties": { "include_defaults": { "type": "boolean", "description": "Indicates if the API should return the default values the system uses for the index's lifecycle", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of index names to explain", "x-found-in": "path" } }, "required": ["index"], "description": "Get the status for a data stream lifecycle.\n\nGet information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.explain_data_lifecycle", "description": "Get the status for a data stream lifecycle.\n\nGet information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", "x-api": { "id": "indices.explain_data_lifecycle", "name": "explain-data-lifecycle", "namespace": "indices" }, "x-method": "GET", "x-path": "/{index}/_lifecycle/explain", "x-urls": [{ "path": "/{index}/_lifecycle/explain", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.11.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "include_defaults": { "type": "boolean", "description": "Indicates if the API should return the default values the system uses for the index's lifecycle", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of index names to explain", "x-found-in": "path" } }, "required": ["index"] }

package/lib/cjs/es/json/indices.field_usage_stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.field_usage_stats", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expressions of fields to include in the statistics.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list or wildcard expression of index names used to limit the request.", "x-found-in": "path" } }, "required": ["index"], "description": "Get field usage stats.\n\nGet field usage information for each shard and field of an index.\nField usage statistics are automatically captured when queries are running on a cluster.\nA shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.\n\nThe response body reports the per-shard usage count of the data structures that back the fields in the index.\nA given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.field_usage_stats", "description": "Get field usage stats.\n\nGet field usage information for each shard and field of an index.\nField usage statistics are automatically captured when queries are running on a cluster.\nA shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.\n\nThe response body reports the per-shard usage count of the data structures that back the fields in the index.\nA given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.", "x-api": { "id": "indices.field_usage_stats", "name": "field-usage-stats", "namespace": "indices" }, "x-method": "GET", "x-path": "/{index}/_field_usage_stats", "x-urls": [{ "path": "/{index}/_field_usage_stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.15.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "private" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expressions of fields to include in the statistics.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list or wildcard expression of index names used to limit the request.", "x-found-in": "path" } }, "required": ["index"] }

package/lib/cjs/es/json/indices.flush.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.flush", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "force": { "type": "boolean", "description": "If `true`, the request forces a flush even if there are no changes to commit to the index.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "wait_if_ongoing": { "type": "boolean", "description": "If `true`, the flush operation blocks until execution when another flush operation is running.\nIf `false`, Elasticsearch returns an error if you request a flush when another flush operation is running.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases to flush.\nSupports wildcards (`*`).\nTo flush all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "description": "Flush data streams or indices.\n\nFlushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index.\nWhen restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart.\nElasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush.\n\nAfter each operation has been flushed it is permanently stored in the Lucene index.\nThis may mean that there is no need to maintain an additional copy of it in the transaction log.\nThe transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space.\n\nIt is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly.\nIf you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.flush", "description": "Flush data streams or indices.\n\nFlushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index.\nWhen restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart.\nElasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush.\n\nAfter each operation has been flushed it is permanently stored in the Lucene index.\nThis may mean that there is no need to maintain an additional copy of it in the transaction log.\nThe transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space.\n\nIt is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly.\nIf you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called.", "x-api": { "id": "indices.flush", "name": "flush", "namespace": "indices" }, "x-method": "POST", "x-path": "/{index}/_flush", "x-urls": [{ "path": "/_flush", "methods": ["POST", "GET"] }, { "path": "/{index}/_flush", "methods": ["POST", "GET"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "force": { "type": "boolean", "description": "If `true`, the request forces a flush even if there are no changes to commit to the index.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "wait_if_ongoing": { "type": "boolean", "description": "If `true`, the flush operation blocks until execution when another flush operation is running.\nIf `false`, Elasticsearch returns an error if you request a flush when another flush operation is running.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases to flush.\nSupports wildcards (`*`).\nTo flush all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } } }

package/lib/cjs/es/json/indices.forcemerge.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.forcemerge", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "x-found-in": "query" }, "flush": { "type": "boolean", "description": "Specify whether the index should be flushed after performing the operation", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "max_num_segments": { "type": "number", "description": "The number of segments the index should be merged into (default: dynamic)", "x-found-in": "query" }, "only_expunge_deletes": { "type": "boolean", "description": "Specify whether the operation should only expunge deleted documents", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "Should the request wait until the force merge is completed", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", "x-found-in": "path" } }, "description": "Force a merge.\n\nPerform the force merge operation on the shards of one or more indices.\nFor data streams, the API forces a merge on the shards of the stream's backing indices.\n\nMerging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents.\nMerging normally happens automatically, but sometimes it is useful to trigger a merge manually.\n\nWARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes).\nWhen documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a \"tombstone\".\nThese soft-deleted documents are automatically cleaned up during regular segment merges.\nBut force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges.\nSo the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance.\nIf you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.\n\n**Blocks during a force merge**\n\nCalls to this API block until the merge is complete (unless request contains `wait_for_completion=false`).\nIf the client connection is lost before completion then the force merge process will continue in the background.\nAny new requests to force merge the same indices will also block until the ongoing force merge is complete.\n\n**Running force merge asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task.\nHowever, you can not cancel this task as the force merge task is not cancelable.\nElasticsearch creates a record of this task as a document at `_tasks/<task_id>`.\n\n**Force merging multiple indices**\n\nYou can force merge multiple indices with a single request by targeting:\n\n* One or more data streams that contain multiple backing indices\n* Multiple indices\n* One or more aliases\n* All data streams and indices in a cluster\n\nEach targeted shard is force-merged separately using the `force_merge` threadpool.\nThe `force_merge` threadpool has a fixed size of `max(1, allocatedProcessors / 8)` per node, which means multiple shards on a node may be force-merged in parallel.\nIf you expand the `force_merge` threadpool on a node then it will force merge its shards with more parallelism.\n\nForce merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case `max_num_segments parameter` is set to `1`, to rewrite all segments into a new one.\n\n**Data streams and time-based indices**\n\nForce-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover.\nIn these cases, each index only receives indexing traffic for a certain period of time.\nOnce an index receive no more writes, its shards can be force-merged to a single segment.\nThis can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches.\nFor example:\n\n```\nPOST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1\n```" }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.forcemerge", "description": "Force a merge.\n\nPerform the force merge operation on the shards of one or more indices.\nFor data streams, the API forces a merge on the shards of the stream's backing indices.\n\nMerging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents.\nMerging normally happens automatically, but sometimes it is useful to trigger a merge manually.\n\nWARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes).\nWhen documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a \"tombstone\".\nThese soft-deleted documents are automatically cleaned up during regular segment merges.\nBut force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges.\nSo the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance.\nIf you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.\n\n**Blocks during a force merge**\n\nCalls to this API block until the merge is complete (unless request contains `wait_for_completion=false`).\nIf the client connection is lost before completion then the force merge process will continue in the background.\nAny new requests to force merge the same indices will also block until the ongoing force merge is complete.\n\n**Running force merge asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task.\nHowever, you can not cancel this task as the force merge task is not cancelable.\nElasticsearch creates a record of this task as a document at `_tasks/<task_id>`.\n\n**Force merging multiple indices**\n\nYou can force merge multiple indices with a single request by targeting:\n\n* One or more data streams that contain multiple backing indices\n* Multiple indices\n* One or more aliases\n* All data streams and indices in a cluster\n\nEach targeted shard is force-merged separately using the `force_merge` threadpool.\nThe `force_merge` threadpool has a fixed size of `max(1, allocatedProcessors / 8)` per node, which means multiple shards on a node may be force-merged in parallel.\nIf you expand the `force_merge` threadpool on a node then it will force merge its shards with more parallelism.\n\nForce merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case `max_num_segments parameter` is set to `1`, to rewrite all segments into a new one.\n\n**Data streams and time-based indices**\n\nForce-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover.\nIn these cases, each index only receives indexing traffic for a certain period of time.\nOnce an index receive no more writes, its shards can be force-merged to a single segment.\nThis can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches.\nFor example:\n\n```\nPOST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1\n```", "x-api": { "id": "indices.forcemerge", "name": "forcemerge", "namespace": "indices" }, "x-method": "POST", "x-path": "/{index}/_forcemerge", "x-urls": [{ "path": "/_forcemerge", "methods": ["POST"] }, { "path": "/{index}/_forcemerge", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "2.1.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "x-found-in": "query" }, "flush": { "type": "boolean", "description": "Specify whether the index should be flushed after performing the operation", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "max_num_segments": { "type": "number", "description": "The number of segments the index should be merged into (default: dynamic)", "x-found-in": "query" }, "only_expunge_deletes": { "type": "boolean", "description": "Specify whether the operation should only expunge deleted documents", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "Should the request wait until the force merge is completed", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", "x-found-in": "path" } } }

package/lib/cjs/es/json/indices.get.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard expressions can match. If the request can target data streams, this argument\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as open,hidden.", "x-found-in": "query" }, "flat_settings": { "type": "boolean", "description": "If true, returns settings in flat format.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If true, return all default settings in the response.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "features": { "$ref": "./indices.get.json#/$defs/indices.get__Features", "description": "Return only information on specified index features", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and index aliases used to limit the request.\nWildcard expressions (*) are supported.", "x-found-in": "path" } }, "required": ["index"], "description": "Get index information.\n\nGet information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get", "description": "Get index information.\n\nGet information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", "x-api": { "id": "indices.get", "name": "get", "namespace": "indices" }, "x-method": "GET", "x-path": "/{index}", "x-urls": [{ "path": "/{index}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard expressions can match. If the request can target data streams, this argument\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as open,hidden.", "x-found-in": "query" }, "flat_settings": { "type": "boolean", "description": "If true, returns settings in flat format.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If true, return all default settings in the response.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "features": { "$ref": "./indices.get.json#/$defs/indices.get__Features", "description": "Return only information on specified index features", "x-found-in": "query", "x-availability": { "stack": { "since": "8.1.0" }, "serverless": {} } }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and index aliases used to limit the request.\nWildcard expressions (*) are supported.", "x-found-in": "path" } }, "required": ["index"] }

package/lib/cjs/es/json/indices.get_alias.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_alias", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list of aliases to retrieve.\nSupports wildcards (`*`).\nTo retrieve all aliases, omit this parameter or use `*` or `_all`.", "x-found-in": "path" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams or indices used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "description": "Get aliases.\n\nRetrieves information for one or more data stream or index aliases." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_alias", "description": "Get aliases.\n\nRetrieves information for one or more data stream or index aliases.", "x-api": { "id": "indices.get_alias", "name": "get-alias", "namespace": "indices" }, "x-method": "GET", "x-path": "/{index}/_alias/{name}", "x-urls": [{ "path": "/_alias", "methods": ["GET"] }, { "path": "/_alias/{name}", "methods": ["GET"] }, { "path": "/{index}/_alias/{name}", "methods": ["GET"] }, { "path": "/{index}/_alias", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list of aliases to retrieve.\nSupports wildcards (`*`).\nTo retrieve all aliases, omit this parameter or use `*` or `_all`.", "x-found-in": "path" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams or indices used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } } }

package/lib/cjs/es/json/indices.get_data_lifecycle.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_data_lifecycle", "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If `true`, return all default settings in the response.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__DataStreamNames", "description": "Comma-separated list of data streams to limit the request.\nSupports wildcards (`*`).\nTo target all data streams, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "required": ["name"], "description": "Get data stream lifecycles.\n\nGet the data stream lifecycle configuration of one or more data streams." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_data_lifecycle", "description": "Get data stream lifecycles.\n\nGet the data stream lifecycle configuration of one or more data streams.", "x-api": { "id": "indices.get_data_lifecycle", "name": "get-data-lifecycle", "namespace": "indices" }, "x-method": "GET", "x-path": "/_data_stream/{name}/_lifecycle", "x-urls": [{ "path": "/_data_stream/{name}/_lifecycle", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.11.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If `true`, return all default settings in the response.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__DataStreamNames", "description": "Comma-separated list of data streams to limit the request.\nSupports wildcards (`*`).\nTo target all data streams, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/indices.get_data_lifecycle_stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_data_lifecycle_stats", "type": "object", "properties": {}, "description": "Get data stream lifecycle stats.\n\nGet statistics about the data streams that are managed by a data stream lifecycle." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_data_lifecycle_stats", "description": "Get data stream lifecycle stats.\n\nGet statistics about the data streams that are managed by a data stream lifecycle.", "x-api": { "id": "indices.get_data_lifecycle_stats", "name": "get-data-lifecycle-stats", "namespace": "indices" }, "x-method": "GET", "x-path": "/_lifecycle/stats", "x-urls": [{ "path": "/_lifecycle/stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "stable" } }, "type": "object", "properties": {} }

package/lib/cjs/es/json/indices.get_data_stream.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_data_stream", "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If true, returns all relevant default configurations for the index template.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "verbose": { "type": "boolean", "description": "Whether the maximum timestamp for each data stream should be calculated and returned.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__DataStreamNames", "description": "Comma-separated list of data stream names used to limit the request.\nWildcard (`*`) expressions are supported. If omitted, all data streams are returned.", "x-found-in": "path" } }, "description": "Get data streams.\n\nGet information about one or more data streams." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_data_stream", "description": "Get data streams.\n\nGet information about one or more data streams.", "x-api": { "id": "indices.get_data_stream", "name": "get-data-stream", "namespace": "indices" }, "x-method": "GET", "x-path": "/_data_stream/{name}", "x-urls": [{ "path": "/_data_stream", "methods": ["GET"] }, { "path": "/_data_stream/{name}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If true, returns all relevant default configurations for the index template.", "x-found-in": "query", "x-availability": { "stack": { "since": "8.11.0", "stability": "stable" }, "serverless": { "stability": "stable" } } }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "verbose": { "type": "boolean", "description": "Whether the maximum timestamp for each data stream should be calculated and returned.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__DataStreamNames", "description": "Comma-separated list of data stream names used to limit the request.\nWildcard (`*`) expressions are supported. If omitted, all data streams are returned.", "x-found-in": "path" } } }

package/lib/cjs/es/json/indices.get_data_stream_mappings.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_data_stream_mappings", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams or data stream patterns. Supports wildcards (`*`).", "x-found-in": "path" } }, "required": ["name"], "description": "Get data stream mappings.\n\nGet mapping information for one or more data streams." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_data_stream_mappings", "description": "Get data stream mappings.\n\nGet mapping information for one or more data streams.", "x-api": { "id": "indices.get_data_stream_mappings", "name": "get-data-stream-mappings", "namespace": "indices" }, "x-method": "GET", "x-path": "/_data_stream/{name}/_mappings", "x-urls": [{ "path": "/_data_stream/{name}/_mappings", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.1.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams or data stream patterns. Supports wildcards (`*`).", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/indices.get_data_stream_options.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_data_stream_options", "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__DataStreamNames", "description": "Comma-separated list of data streams to limit the request.\nSupports wildcards (`*`).\nTo target all data streams, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "required": ["name"], "description": "Get data stream options.\n\nGet the data stream options configuration of one or more data streams." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_data_stream_options", "description": "Get data stream options.\n\nGet the data stream options configuration of one or more data streams.", "x-api": { "id": "indices.get_data_stream_options", "name": "get-data-stream-options", "namespace": "indices" }, "x-method": "GET", "x-path": "/_data_stream/{name}/_options", "x-urls": [{ "path": "/_data_stream/{name}/_options", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.19.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__DataStreamNames", "description": "Comma-separated list of data streams to limit the request.\nSupports wildcards (`*`).\nTo target all data streams, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/indices.get_data_stream_settings.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_data_stream_settings", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams or data stream patterns. Supports wildcards (`*`).", "x-found-in": "path" } }, "required": ["name"], "description": "Get data stream settings.\n\nGet setting information for one or more data streams." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_data_stream_settings", "description": "Get data stream settings.\n\nGet setting information for one or more data streams.", "x-api": { "id": "indices.get_data_stream_settings", "name": "get-data-stream-settings", "namespace": "indices" }, "x-method": "GET", "x-path": "/_data_stream/{name}/_settings", "x-urls": [{ "path": "/_data_stream/{name}/_settings", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.1.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams or data stream patterns. Supports wildcards (`*`).", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/indices.get_field_mapping.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_field_mapping", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If `true`, return all default settings in the response.", "x-found-in": "query" }, "fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expression of fields used to limit returned information.\nSupports wildcards (`*`).", "x-found-in": "path" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "required": ["fields"], "description": "Get mapping definitions.\n\nRetrieves mapping definitions for one or more fields.\nFor data streams, the API retrieves field mappings for the stream’s backing indices.\n\nThis API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_field_mapping", "description": "Get mapping definitions.\n\nRetrieves mapping definitions for one or more fields.\nFor data streams, the API retrieves field mappings for the stream’s backing indices.\n\nThis API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.", "x-api": { "id": "indices.get_field_mapping", "name": "get-field-mapping", "namespace": "indices" }, "x-method": "GET", "x-path": "/{index}/_mapping/field/{fields}", "x-urls": [{ "path": "/_mapping/field/{fields}", "methods": ["GET"] }, { "path": "/{index}/_mapping/field/{fields}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If `true`, return all default settings in the response.", "x-found-in": "query" }, "fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expression of fields used to limit returned information.\nSupports wildcards (`*`).", "x-found-in": "path" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "required": ["fields"] }

package/lib/cjs/es/json/indices.get_index_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_index_template", "type": "object", "properties": { "local": { "type": "boolean", "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", "x-found-in": "query" }, "flat_settings": { "type": "boolean", "description": "If true, returns settings in flat format.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If true, returns all relevant default configurations for the index template.", "x-found-in": "query" }, "name": { "type": "string", "description": "Name of index template to retrieve. Wildcard (*) expressions are supported.", "x-found-in": "path" } }, "description": "Get index templates.\n\nGet information about one or more index templates." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_index_template", "description": "Get index templates.\n\nGet information about one or more index templates.", "x-api": { "id": "indices.get_index_template", "name": "get-index-template", "namespace": "indices" }, "x-method": "GET", "x-path": "/_index_template/{name}", "x-urls": [{ "path": "/_index_template", "methods": ["GET"] }, { "path": "/_index_template/{name}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "local": { "type": "boolean", "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", "x-found-in": "query", "x-deprecated": { "since": "9.0.0", "description": "This parameter has no effect, is now deprecated, and will be removed in a future version." } }, "flat_settings": { "type": "boolean", "description": "If true, returns settings in flat format.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If true, returns all relevant default configurations for the index template.", "x-found-in": "query", "x-availability": { "stack": { "since": "8.11.0", "stability": "stable" }, "serverless": { "stability": "stable" } } }, "name": { "type": "string", "description": "Name of index template to retrieve. Wildcard (*) expressions are supported.", "x-found-in": "path" } } }

package/lib/cjs/es/json/indices.get_mapping.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_mapping", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "description": "Get mapping definitions.\n\nFor data streams, the API retrieves mappings for the stream’s backing indices." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_mapping", "description": "Get mapping definitions.\n\nFor data streams, the API retrieves mappings for the stream’s backing indices.", "x-api": { "id": "indices.get_mapping", "name": "get-mapping", "namespace": "indices" }, "x-method": "GET", "x-path": "/{index}/_mapping", "x-urls": [{ "path": "/_mapping", "methods": ["GET"] }, { "path": "/{index}/_mapping", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.", "x-found-in": "query", "x-deprecated": { "since": "7.8.0", "description": "This parameter is a no-op and field mappings are always retrieved locally." } }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } } }

package/lib/cjs/es/json/indices.get_migrate_reindex_status.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_migrate_reindex_status", "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "The index or data stream name.", "x-found-in": "path" } }, "required": ["index"], "description": "Get the migration reindexing status.\n\nGet the status of a migration reindex attempt for a data stream or index." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_migrate_reindex_status", "description": "Get the migration reindexing status.\n\nGet the status of a migration reindex attempt for a data stream or index.", "x-api": { "id": "indices.get_migrate_reindex_status", "name": "get-migrate-reindex-status", "namespace": "indices" }, "x-method": "GET", "x-path": "/_migration/reindex/{index}/_status", "x-urls": [{ "path": "/_migration/reindex/{index}/_status", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.18.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "The index or data stream name.", "x-found-in": "path" } }, "required": ["index"] }

package/lib/cjs/es/json/indices.get_settings.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_settings", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If `true`, return all default settings in the response.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only. If\n`false`, information is retrieved from the master node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases used to limit\nthe request. Supports wildcards (`*`). To target all data streams and\nindices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list or wildcard expression of settings to retrieve.", "x-found-in": "path" } }, "description": "Get index settings.\n\nGet setting information for one or more indices.\nFor data streams, it returns setting information for the stream's backing indices." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_settings", "description": "Get index settings.\n\nGet setting information for one or more indices.\nFor data streams, it returns setting information for the stream's backing indices.", "x-api": { "id": "indices.get_settings", "name": "get-settings", "namespace": "indices" }, "x-method": "GET", "x-path": "/{index}/_settings/{name}", "x-urls": [{ "path": "/_settings", "methods": ["GET"] }, { "path": "/{index}/_settings", "methods": ["GET"] }, { "path": "/{index}/_settings/{name}", "methods": ["GET"] }, { "path": "/_settings/{name}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If `true`, return all default settings in the response.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only. If\n`false`, information is retrieved from the master node.", "x-found-in": "query", "x-deprecated": { "since": "9.1.0", "description": "This parameter is a no-op and settings are always retrieved locally." } }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases used to limit\nthe request. Supports wildcards (`*`). To target all data streams and\nindices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list or wildcard expression of settings to retrieve.", "x-found-in": "path" } } }

package/lib/cjs/es/json/indices.get_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_template", "type": "object", "properties": { "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list of index template names used to limit the request.\nWildcard (`*`) expressions are supported.\nTo return all index templates, omit this parameter or use a value of `_all` or `*`.", "x-found-in": "path" } }, "description": "Get legacy index templates.\n\nGet information about one or more index templates.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.get_template", "description": "Get legacy index templates.\n\nGet information about one or more index templates.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.", "x-api": { "id": "indices.get_template", "name": "get-template", "namespace": "indices" }, "x-method": "GET", "x-path": "/_template/{name}", "x-urls": [{ "path": "/_template", "methods": ["GET"] }, { "path": "/_template/{name}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" } }, "x-deprecated": { "since": "7.8.0" }, "type": "object", "properties": { "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.", "x-found-in": "query", "x-deprecated": { "since": "9.0.0", "description": "This parameter is a no-op and templates are always retrieved locally." } }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list of index template names used to limit the request.\nWildcard (`*`) expressions are supported.\nTo return all index templates, omit this parameter or use a value of `_all` or `*`.", "x-found-in": "path" } } }

package/lib/cjs/es/json/indices.migrate_reindex.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.migrate_reindex", "type": "object", "properties": { "reindex": { "$ref": "./indices.migrate_reindex.json#/$defs/indices.migrate_reindex__MigrateReindex", "x-found-in": "body" } }, "description": "Reindex legacy backing indices.\n\nReindex all legacy backing indices for a data stream.\nThis operation occurs in a persistent task.\nThe persistent task ID is returned immediately and the reindexing work is completed in that task." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.migrate_reindex", "description": "Reindex legacy backing indices.\n\nReindex all legacy backing indices for a data stream.\nThis operation occurs in a persistent task.\nThe persistent task ID is returned immediately and the reindexing work is completed in that task.", "x-api": { "id": "indices.migrate_reindex", "name": "migrate-reindex", "namespace": "indices" }, "x-method": "POST", "x-path": "/_migration/reindex", "x-urls": [{ "path": "/_migration/reindex", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.18.0", "stability": "stable" } }, "type": "object", "properties": { "reindex": { "$ref": "./indices.migrate_reindex.json#/$defs/indices.migrate_reindex__MigrateReindex", "x-found-in": "body", "x-body-root": true } } }

package/lib/cjs/es/json/indices.migrate_to_data_stream.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.migrate_to_data_stream", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "type": "string", "description": "Name of the index alias to convert to a data stream.", "x-found-in": "path" } }, "required": ["name"], "description": "Convert an index alias to a data stream.\n\nConverts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.migrate_to_data_stream", "description": "Convert an index alias to a data stream.\n\nConverts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", "x-api": { "id": "indices.migrate_to_data_stream", "name": "migrate-to-data-stream", "namespace": "indices" }, "x-method": "POST", "x-path": "/_data_stream/_migrate/{name}", "x-urls": [{ "path": "/_data_stream/_migrate/{name}", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "type": "string", "description": "Name of the index alias to convert to a data stream.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/indices.modify_data_stream.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.modify_data_stream", "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "./indices.modify_data_stream.json#/$defs/indices.modify_data_stream__Action" }, "description": "Actions to perform.", "x-found-in": "body" } }, "required": ["actions"], "description": "Update data streams.\n\nPerforms one or more data stream modification actions in a single atomic operation." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.modify_data_stream", "description": "Update data streams.\n\nPerforms one or more data stream modification actions in a single atomic operation.", "x-api": { "id": "indices.modify_data_stream", "name": "modify-data-stream", "namespace": "indices" }, "x-method": "POST", "x-path": "/_data_stream/_modify", "x-urls": [{ "path": "/_data_stream/_modify", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.16.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "./indices.modify_data_stream.json#/$defs/indices.modify_data_stream__Action" }, "description": "Actions to perform.", "x-found-in": "body" } }, "required": ["actions"] }

package/lib/cjs/es/json/indices.open.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.open", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nBy default, you must explicitly name the indices you using to limit the request.\nTo limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false.\nYou can update this setting in the `elasticsearch.yml` file or using the cluster update settings API.", "x-found-in": "path" } }, "required": ["index"], "description": "Open a closed index.\n\nFor data streams, the API opens any closed backing indices.\n\nA closed index is blocked for read/write operations and does not allow all operations that opened indices allow.\nIt is not possible to index documents or to search for documents in a closed index.\nThis allows closed indices to not have to maintain internal data structures for indexing or searching documents, resulting in a smaller overhead on the cluster.\n\nWhen opening or closing an index, the master is responsible for restarting the index shards to reflect the new state of the index.\nThe shards will then go through the normal recovery process.\nThe data of opened or closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.\n\nYou can open and close multiple indices.\nAn error is thrown if the request explicitly refers to a missing index.\nThis behavior can be turned off by using the `ignore_unavailable=true` parameter.\n\nBy default, you must explicitly name the indices you are opening or closing.\nTo open or close indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.\nThis setting can also be changed with the cluster update settings API.\n\nClosed indices consume a significant amount of disk-space which can cause problems in managed environments.\nClosing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`.\n\nBecause opening or closing an index allocates its shards, the `wait_for_active_shards` setting on index creation applies to the `_open` and `_close` index actions as well." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.open", "description": "Open a closed index.\n\nFor data streams, the API opens any closed backing indices.\n\nA closed index is blocked for read/write operations and does not allow all operations that opened indices allow.\nIt is not possible to index documents or to search for documents in a closed index.\nThis allows closed indices to not have to maintain internal data structures for indexing or searching documents, resulting in a smaller overhead on the cluster.\n\nWhen opening or closing an index, the master is responsible for restarting the index shards to reflect the new state of the index.\nThe shards will then go through the normal recovery process.\nThe data of opened or closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.\n\nYou can open and close multiple indices.\nAn error is thrown if the request explicitly refers to a missing index.\nThis behavior can be turned off by using the `ignore_unavailable=true` parameter.\n\nBy default, you must explicitly name the indices you are opening or closing.\nTo open or close indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.\nThis setting can also be changed with the cluster update settings API.\n\nClosed indices consume a significant amount of disk-space which can cause problems in managed environments.\nClosing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`.\n\nBecause opening or closing an index allocates its shards, the `wait_for_active_shards` setting on index creation applies to the `_open` and `_close` index actions as well.", "x-api": { "id": "indices.open", "name": "open", "namespace": "indices" }, "x-method": "POST", "x-path": "/{index}/_open", "x-urls": [{ "path": "/{index}/_open", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "x-found-in": "query", "x-availability": { "stack": {} } }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nBy default, you must explicitly name the indices you using to limit the request.\nTo limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false.\nYou can update this setting in the `elasticsearch.yml` file or using the cluster update settings API.", "x-found-in": "path" } }, "required": ["index"] }

package/lib/cjs/es/json/indices.promote_data_stream.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.promote_data_stream", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "name": { "type": "string", "description": "The name of the data stream to promote", "x-found-in": "path" } }, "required": ["name"], "description": "Promote a data stream.\n\nPromote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream.\n\nWith CCR auto following, a data stream from a remote cluster can be replicated to the local cluster.\nThese data streams can't be rolled over in the local cluster.\nThese replicated data streams roll over only if the upstream data stream rolls over.\nIn the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster.\n\nNOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream.\nIf this is missing, the data stream will not be able to roll over until a matching index template is created.\nThis will affect the lifecycle management of the data stream and interfere with the data stream size and retention." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.promote_data_stream", "description": "Promote a data stream.\n\nPromote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream.\n\nWith CCR auto following, a data stream from a remote cluster can be replicated to the local cluster.\nThese data streams can't be rolled over in the local cluster.\nThese replicated data streams roll over only if the upstream data stream rolls over.\nIn the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster.\n\nNOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream.\nIf this is missing, the data stream will not be able to roll over until a matching index template is created.\nThis will affect the lifecycle management of the data stream and interfere with the data stream size and retention.", "x-api": { "id": "indices.promote_data_stream", "name": "promote-data-stream", "namespace": "indices" }, "x-method": "POST", "x-path": "/_data_stream/_promote/{name}", "x-urls": [{ "path": "/_data_stream/_promote/{name}", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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.", "x-found-in": "query" }, "name": { "type": "string", "description": "The name of the data stream to promote", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/indices.put_alias.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_alias", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Query used to limit documents the alias can access.", "x-found-in": "body" }, "index_routing": { "type": "string", "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.\nData stream aliases don’t support this parameter.", "x-found-in": "body" }, "is_write_index": { "type": "boolean", "description": "If `true`, sets the write index or data stream for the alias.\nIf an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.\nIf an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.\nData stream aliases don’t automatically set a write data stream, even if the alias points to one data stream.", "x-found-in": "body" }, "routing": { "type": "string", "description": "Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter.", "x-found-in": "body" }, "search_routing": { "type": "string", "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.\nData stream aliases don’t support this parameter.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams or indices to add.\nSupports wildcards (`*`).\nWildcard patterns that match both data streams and indices return an error.", "x-found-in": "path" }, "name": { "type": "string", "description": "Alias to update.\nIf the alias doesn’t exist, the request creates it.\nIndex alias names support date math.", "x-found-in": "path" } }, "required": ["index", "name"], "description": "Create or update an alias.\n\nAdds a data stream or index to an alias." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_alias", "description": "Create or update an alias.\n\nAdds a data stream or index to an alias.", "x-api": { "id": "indices.put_alias", "name": "put-alias", "namespace": "indices" }, "x-method": "PUT", "x-path": "/{index}/_aliases/{name}", "x-urls": [{ "path": "/{index}/_alias/{name}", "methods": ["PUT", "POST"] }, { "path": "/{index}/_aliases/{name}", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Query used to limit documents the alias can access.", "x-found-in": "body" }, "index_routing": { "type": "string", "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.\nData stream aliases don’t support this parameter.", "x-found-in": "body" }, "is_write_index": { "type": "boolean", "description": "If `true`, sets the write index or data stream for the alias.\nIf an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.\nIf an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.\nData stream aliases don’t automatically set a write data stream, even if the alias points to one data stream.", "x-found-in": "body" }, "routing": { "type": "string", "description": "Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter.", "x-found-in": "body" }, "search_routing": { "type": "string", "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.\nData stream aliases don’t support this parameter.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams or indices to add.\nSupports wildcards (`*`).\nWildcard patterns that match both data streams and indices return an error.", "x-found-in": "path" }, "name": { "type": "string", "description": "Alias to update.\nIf the alias doesn’t exist, the request creates it.\nIndex alias names support date math.", "x-found-in": "path" } }, "required": ["index", "name"] }

package/lib/cjs/es/json/indices.put_data_lifecycle.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_data_lifecycle", "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "data_retention": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.", "x-found-in": "body" }, "downsampling": { "type": "array", "items": { "$ref": "./indices._types.json#/$defs/indices._types__DownsamplingRound" }, "description": "The downsampling configuration to execute for the managed backing index after rollover.", "x-found-in": "body" }, "downsampling_method": { "$ref": "./indices._types.json#/$defs/indices._types__SamplingMethod", "description": "The method used to downsample the data. There are two options `aggregate` and `last_value`. It requires\n`downsampling` to be defined. Defaults to `aggregate`.", "x-found-in": "body" }, "enabled": { "type": "boolean", "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.", "x-found-in": "body" }, "name": { "$ref": "./_types.json#/$defs/_types__DataStreamNames", "description": "Comma-separated list of data streams used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams use `*` or `_all`.", "x-found-in": "path" } }, "required": ["name"], "description": "Update data stream lifecycles.\n\nUpdate the data stream lifecycle of the specified data streams." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_data_lifecycle", "description": "Update data stream lifecycles.\n\nUpdate the data stream lifecycle of the specified data streams.", "x-api": { "id": "indices.put_data_lifecycle", "name": "put-data-lifecycle", "namespace": "indices" }, "x-method": "PUT", "x-path": "/_data_stream/{name}/_lifecycle", "x-urls": [{ "path": "/_data_stream/{name}/_lifecycle", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.11.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "data_retention": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.", "x-found-in": "body" }, "downsampling": { "type": "array", "items": { "$ref": "./indices._types.json#/$defs/indices._types__DownsamplingRound" }, "description": "The downsampling configuration to execute for the managed backing index after rollover.", "x-found-in": "body" }, "downsampling_method": { "$ref": "./indices._types.json#/$defs/indices._types__SamplingMethod", "description": "The method used to downsample the data. There are two options `aggregate` and `last_value`. It requires\n`downsampling` to be defined. Defaults to `aggregate`.", "x-found-in": "body" }, "enabled": { "type": "boolean", "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.", "x-found-in": "body" }, "name": { "$ref": "./_types.json#/$defs/_types__DataStreamNames", "description": "Comma-separated list of data streams used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams use `*` or `_all`.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/indices.put_data_stream_mappings.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_data_stream_mappings", "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "If `true`, the request does not actually change the mappings on any data streams. Instead, it\nsimulates changing the settings and reports back to the user what would have happened had these settings\nactually been applied.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__TypeMapping", "x-found-in": "body" }, "name": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams or data stream patterns.", "x-found-in": "path" } }, "required": ["name"], "description": "Update data stream mappings.\n\nThis API can be used to override mappings on specific data streams. These overrides will take precedence over what\nis specified in the template that the data stream matches. The mapping change is only applied to new write indices\nthat are created during rollover after this API is called. No indices are changed by this API." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_data_stream_mappings", "description": "Update data stream mappings.\n\nThis API can be used to override mappings on specific data streams. These overrides will take precedence over what\nis specified in the template that the data stream matches. The mapping change is only applied to new write indices\nthat are created during rollover after this API is called. No indices are changed by this API.", "x-api": { "id": "indices.put_data_stream_mappings", "name": "put-data-stream-mappings", "namespace": "indices" }, "x-method": "PUT", "x-path": "/_data_stream/{name}/_mappings", "x-urls": [{ "path": "/_data_stream/{name}/_mappings", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "9.2.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "If `true`, the request does not actually change the mappings on any data streams. Instead, it\nsimulates changing the settings and reports back to the user what would have happened had these settings\nactually been applied.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__TypeMapping", "x-found-in": "body", "x-body-root": true }, "name": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams or data stream patterns.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/indices.put_data_stream_options.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_data_stream_options", "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "failure_store": { "$ref": "./indices._types.json#/$defs/indices._types__DataStreamFailureStore", "description": "If defined, it will update the failure store configuration of every data stream resolved by the name expression.", "x-found-in": "body" }, "name": { "$ref": "./_types.json#/$defs/_types__DataStreamNames", "description": "Comma-separated list of data streams used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams use `*` or `_all`.", "x-found-in": "path" } }, "required": ["name"], "description": "Update data stream options.\n\nUpdate the data stream options of the specified data streams." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_data_stream_options", "description": "Update data stream options.\n\nUpdate the data stream options of the specified data streams.", "x-api": { "id": "indices.put_data_stream_options", "name": "put-data-stream-options", "namespace": "indices" }, "x-method": "PUT", "x-path": "/_data_stream/{name}/_options", "x-urls": [{ "path": "/_data_stream/{name}/_options", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.19.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "failure_store": { "$ref": "./indices._types.json#/$defs/indices._types__DataStreamFailureStore", "description": "If defined, it will update the failure store configuration of every data stream resolved by the name expression.", "x-found-in": "body" }, "name": { "$ref": "./_types.json#/$defs/_types__DataStreamNames", "description": "Comma-separated list of data streams used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams use `*` or `_all`.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/indices.put_data_stream_settings.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_data_stream_settings", "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "If `true`, the request does not actually change the settings on any data streams or indices. Instead, it\nsimulates changing the settings and reports back to the user what would have happened had these settings\nactually been applied.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "settings": { "$ref": "./indices._types.json#/$defs/indices._types__IndexSettings", "x-found-in": "body" }, "name": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams or data stream patterns.", "x-found-in": "path" } }, "required": ["name"], "description": "Update data stream settings.\n\nNOTE: Available in 8.19. Not available in earlier versions.\n\nThis API can be used to override settings on specific data streams. These overrides will take precedence over what\nis specified in the template that the data stream matches. To prevent your data stream from getting into an invalid state,\nonly certain settings are allowed. If possible, the setting change is applied to all\nbacking indices. Otherwise, it will be applied when the data stream is next rolled over." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_data_stream_settings", "description": "Update data stream settings.\n\nNOTE: Available in 8.19. Not available in earlier versions.\n\nThis API can be used to override settings on specific data streams. These overrides will take precedence over what\nis specified in the template that the data stream matches. To prevent your data stream from getting into an invalid state,\nonly certain settings are allowed. If possible, the setting change is applied to all\nbacking indices. Otherwise, it will be applied when the data stream is next rolled over.", "x-api": { "id": "indices.put_data_stream_settings", "name": "put-data-stream-settings", "namespace": "indices" }, "x-method": "PUT", "x-path": "/_data_stream/{name}/_settings", "x-urls": [{ "path": "/_data_stream/{name}/_settings", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "9.1.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "If `true`, the request does not actually change the settings on any data streams or indices. Instead, it\nsimulates changing the settings and reports back to the user what would have happened had these settings\nactually been applied.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "settings": { "$ref": "./indices._types.json#/$defs/indices._types__IndexSettings", "x-found-in": "body", "x-body-root": true }, "name": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams or data stream patterns.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/indices.put_index_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_index_template", "type": "object", "properties": { "create": { "type": "boolean", "description": "If `true`, this request cannot replace or update existing index templates.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "cause": { "type": "string", "description": "User defined reason for creating or updating the index template", "x-found-in": "query" }, "index_patterns": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.", "x-found-in": "body" }, "composed_of": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", "x-found-in": "body" }, "template": { "$ref": "./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping", "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", "x-found-in": "body" }, "data_stream": { "$ref": "./indices._types.json#/$defs/indices._types__DataStreamVisibility", "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.", "x-found-in": "body" }, "priority": { "type": "number", "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "version": { "type": "number", "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.\nExternal systems can use these version numbers to simplify template management.\nTo unset a version, replace the template without specifying one.", "x-found-in": "body" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional user metadata about the index template.\nIt may have any contents.\nIt is not automatically generated or used by Elasticsearch.\nThis user-defined object is stored in the cluster state, so keeping it short is preferable\nTo unset the metadata, replace the template without specifying it.", "x-found-in": "body" }, "allow_auto_create": { "type": "boolean", "description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf 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`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.", "x-found-in": "body" }, "ignore_missing_component_templates": { "type": "array", "items": { "type": "string" }, "description": "The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist", "x-found-in": "body" }, "deprecated": { "type": "boolean", "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.", "x-found-in": "body" }, "name": { "type": "string", "description": "Index or template name", "x-found-in": "path" } }, "required": ["name"], "description": "Create or update an index template.\n\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nElasticsearch applies templates to new indices based on an wildcard pattern that matches the index name.\nIndex templates are applied during data stream or index creation.\nFor data streams, these settings and mappings are applied when the stream's backing indices are created.\nSettings and mappings specified in a create index API request override any settings or mappings specified in an index template.\nChanges to index templates do not affect existing indices, including the existing backing indices of a data stream.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Multiple matching templates**\n\nIf multiple index templates match the name of a new index or data stream, the template with the highest priority is used.\n\nMultiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities.\n\n**Composing aliases, mappings, and settings**\n\nWhen multiple component templates are specified in the `composed_of` field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates.\nAny mappings, settings, or aliases from the parent index template are merged in next.\nFinally, any configuration on the index request itself is merged.\nMapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration.\nIf a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one.\nThis recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`.\nIf an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end.\nIf an entry already exists with the same key, then it is overwritten by the new definition." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_index_template", "description": "Create or update an index template.\n\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nElasticsearch applies templates to new indices based on an wildcard pattern that matches the index name.\nIndex templates are applied during data stream or index creation.\nFor data streams, these settings and mappings are applied when the stream's backing indices are created.\nSettings and mappings specified in a create index API request override any settings or mappings specified in an index template.\nChanges to index templates do not affect existing indices, including the existing backing indices of a data stream.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Multiple matching templates**\n\nIf multiple index templates match the name of a new index or data stream, the template with the highest priority is used.\n\nMultiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities.\n\n**Composing aliases, mappings, and settings**\n\nWhen multiple component templates are specified in the `composed_of` field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates.\nAny mappings, settings, or aliases from the parent index template are merged in next.\nFinally, any configuration on the index request itself is merged.\nMapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration.\nIf a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one.\nThis recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`.\nIf an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end.\nIf an entry already exists with the same key, then it is overwritten by the new definition.", "x-api": { "id": "indices.put_index_template", "name": "put-index-template", "namespace": "indices" }, "x-method": "PUT", "x-path": "/_index_template/{name}", "x-urls": [{ "path": "/_index_template/{name}", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "create": { "type": "boolean", "description": "If `true`, this request cannot replace or update existing index templates.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "cause": { "type": "string", "description": "User defined reason for creating or updating the index template", "x-found-in": "query" }, "index_patterns": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.", "x-found-in": "body" }, "composed_of": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", "x-found-in": "body" }, "template": { "$ref": "./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping", "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", "x-found-in": "body" }, "data_stream": { "$ref": "./indices._types.json#/$defs/indices._types__DataStreamVisibility", "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.", "x-found-in": "body" }, "priority": { "type": "number", "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "version": { "type": "number", "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.\nExternal systems can use these version numbers to simplify template management.\nTo unset a version, replace the template without specifying one.", "x-found-in": "body" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional user metadata about the index template.\nIt may have any contents.\nIt is not automatically generated or used by Elasticsearch.\nThis user-defined object is stored in the cluster state, so keeping it short is preferable\nTo unset the metadata, replace the template without specifying it.", "x-found-in": "body" }, "allow_auto_create": { "type": "boolean", "description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf 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`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.", "x-found-in": "body" }, "ignore_missing_component_templates": { "type": "array", "items": { "type": "string" }, "description": "The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist", "x-found-in": "body" }, "deprecated": { "type": "boolean", "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.", "x-found-in": "body" }, "name": { "type": "string", "description": "Index or template name", "x-found-in": "path" } }, "required": ["name"] }